Route - Get Route Directions

Služba:
Maps
Verze rozhraní API:
1.0

Slouží k výpočtu trasy mezi zadaným původem a cílem, která prochází všemi zadanými směrovými body.

Poznámka:

vyřazení služby Azure Maps Route v1

Služba Azure Maps Route v1 je nyní zastaralá a bude vyřazena 31. 31. 28. Aby nedošlo k přerušení služeb, bude potřeba aktualizovat všechna volání služby Route v1, aby používala službu Route v2025-01-01 do 31. 31. 28. Další informace najdete v tématu Migrace rozhraní API služby Azure Maps Route 1.0.

Rozhraní API Get Route Directions je požadavek HTTP GET, který v případě zadání vrací trasu mezi zdrojem a cílem. Trasa bere v úvahu faktory, jako je aktuální provoz a typická rychlost silničního provozu v požadovaném dni v týdnu a denní čas.

Vrácené informace zahrnují vzdálenost, odhadovanou dobu jízdy a reprezentaci geometrie trasy. V závislosti na vybraných možnostech jsou k dispozici také další informace o směrování, jako je optimalizované pořadí směrovacích bodů nebo zapnutí podle pokynů pro otáčení.

Směrovací služba poskytuje sadu parametrů pro podrobný popis modelu spotřeby specifického pro vozidla. Další informace najdete v tématu model consumption.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
S volitelnými parametry: 
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
format
 path True

ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.
api-version
 query True

string

Číslo verze rozhraní API služby Azure Maps
query
 query True

string

Souřadnice, kterými se trasa vypočítá, oddělená dvojtečkam. Vyžaduje se minimálně dvě souřadnice. První je původ a poslední je cílem trasy. Volitelné souřadnice mezi operacemi fungují jako směrovací body v trase. Můžete předat až 150 waypointů.
accelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

Určuje účinnost převodu chemické energie uložené v palivu na kinetickou energii, když vozidlo zrychluje (tj. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed je získán převodem spotřebovaného paliva na chemickou energii pomocí fuelEnergyDensityInMJoulesPerLiter.

Musí být spárovány s deceleračníEfficiency.

Rozsah povolených hodnot je 0,0 až 1/deceleraceEfficiency.

Rozumné hodnoty : pro spalovací model : 0,33, pro elektrický model : 0,66
alternativeType
 query

AlternativeRouteType

Řídí optimální výkon vzhledem k zadaným kritériím plánování počítaných alternativ v porovnání s referenční trasou.
arriveAt
 query

string (date-time)

Datum a čas doručení v cílovém bodě formátovaný jako hodnota dateTime definovaná v RFC 3339, oddíl 5.6s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o cílový bod.

Příklady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Parametr arriveAt nelze použít ve spojení s departAt, minDeviationDistance nebo minDeviationTime.
auxiliaryPowerInkW
 query

number (double)

Určuje množství energie spotřebované pro udržitelné pomocné systémy v kilowattech (kW).

Lze ji použít k určení spotřeby z důvodu zařízení a systémů, jako jsou systémy AC, rádio, topení atd.

Rozumné hodnoty : 1,7
auxiliaryPowerInLitersPerHour
 query

number (double)

Určuje množství paliva spotřebované pro udržování pomocných systémů vozidla v litrech za hodinu.

Lze ji použít k určení spotřeby z důvodu zařízení a systémů, jako jsou systémy AC, rádio, topení atd.

Rozumné hodnoty : 0,2
avoid
 query

RouteAvoidType[]

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.
computeBestOrder
 query

boolean

Přeuspořádejte směrovací body pomocí rychlého heuristického algoritmu, abyste snížili délku trasy. Poskytuje nejlepší výsledky při použití ve spojení s routeType nejkratší. Všimněte si, že původ a cíl jsou vyloučené z optimalizovaných indexů směrových bodů. Pokud chcete do odpovědi zahrnout původ a cíl, zvyšte všechny indexy o 1, abyste zohlednili původ, a pak přidejte cíl jako konečný index. Možné hodnoty jsou true nebo false. Pravda vypočítá lepší pořadí, pokud je to možné, ale není povoleno používat ve spojení s hodnotou maxAlternatives větší než 0 nebo ve spojení s kruhovými směrovými body. False bude používat umístění v daném pořadí a nesmí být použity ve spojení s routeRepresentation žádné.
computeTravelTimeFor
 query

ComputeTravelTime

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.
constantSpeedConsumptionInkWhPerHundredkm
 query

string

Určuje součást spotřeby závislá na rychlosti.

Poskytuje se jako neuspořádaný seznam dvojic rychlostí/spotřeba. Seznam definuje body na křivkě spotřeby. Sazby spotřeby pro rychlosti, které nejsou v seznamu, se nacházejí takto:

  • lineární interpolací, pokud daná rychlost leží mezi dvěma rychlostmi v seznamu

  • lineární extrapolací jinak za předpokladu, že konstanta (ΔConsumption/ΔSpeed) určená nejbližšími dvěma body v seznamu

Seznam musí obsahovat 1 až 25 bodů (včetně) a nesmí obsahovat duplicitní body pro stejnou rychlost. Pokud obsahuje pouze jeden bod, použije se spotřeba tohoto bodu bez dalšího zpracování.

Spotřeba zadaná pro největší rychlost musí být větší nebo rovna hodnotě předposlední největší rychlosti. Tím se zajistí, že extrapolace nezáporná míra spotřeby nezáporná.

Podobně hodnoty spotřeby zadané pro dvě nejmenší rychlosti v seznamu nemohou vést k záporné spotřebě pro jakoukoli menší rychlost.

Platný rozsah pro hodnoty spotřeby (vyjádřený v kWh/100km) je mezi 0,01 a 100000,0.

Rozumné hodnoty : 50,8.2:130,21,3

Tento parametr je vyžadován pro model elektrické spotřeby.
constantSpeedConsumptionInLitersPerHundredkm
 query

string

Určuje součást spotřeby závislá na rychlosti.

Poskytuje se jako neuspořádaný seznam rychlostí oddělených dvojtečkami & páry spotřeby. Seznam definuje body na křivkě spotřeby. Sazby spotřeby pro rychlosti, které nejsou v seznamu, se nacházejí takto:

  • lineární interpolací, pokud daná rychlost leží mezi dvěma rychlostmi v seznamu

  • lineární extrapolací jinak za předpokladu, že konstanta (ΔConsumption/ΔSpeed) určená nejbližšími dvěma body v seznamu

Seznam musí obsahovat 1 až 25 bodů (včetně) a nesmí obsahovat duplicitní body pro stejnou rychlost. Pokud obsahuje pouze jeden bod, použije se spotřeba tohoto bodu bez dalšího zpracování.

Spotřeba zadaná pro největší rychlost musí být větší nebo rovna hodnotě předposlední největší rychlosti. Tím se zajistí, že extrapolace nezáporná míra spotřeby nezáporná.

Podobně hodnoty spotřeby zadané pro dvě nejmenší rychlosti v seznamu nemohou vést k záporné spotřebě pro jakoukoli menší rychlost.

Platný rozsah pro hodnoty spotřeby (vyjádřený v l/100km) je mezi 0,01 a 100000,0.

Rozumné hodnoty : 50,6.3:130,11,5

Poznámka: Tento parametr je vyžadován pro model spotřeby spalování.
currentChargeInkWh
 query

number (double)

Určuje aktuální zdroj elektrické energie v kilowatthodinách (kWh).

Tento parametr existuje společně s parametrem maxChargeInkWh.

Rozsah povolených hodnot je 0,0 až maxChargeInkWh.

Rozumné hodnoty : 43
currentFuelInLiters
 query

number (double)

Určuje aktuální dodávku paliva v literech.

Rozumné hodnoty : 55
decelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

Určuje účinnost převodu kinetické energie na úsporné (nezpotřebované) paliva, když vozidlo deceleruje (tj. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved je získán převodem uloženého (nespotřebovaného) paliva na energii pomocí fuelEnergyDensityInMJoulesPerLiter.

Musí být spárovány s akceleracíEfficiency.

Rozsah povolených hodnot je 0,0 až 1/akceleraceEfficiency.

Rozumné hodnoty : pro spalovací model : 0,83, pro elektrický model : 0,91
departAt
 query

string (date-time)

Datum a čas odjezdu od počátečního bodu formátované jako dateTime hodnota definovaná v RFC 3339, oddíl 5.6, s volitelným posunem časového pásma. Pokud není zadán posun časového pásma, předpokládá se, že se jedná o počáteční bod.

  • Výchozí hodnota: teď
  • Jiná hodnota: dateTime

Příklady:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

Parametr departAt nelze použít ve spojení s arriveAt.
downhillEfficiency
 query

number (double)

minimum: 0
maximum: 1

Určuje účinnost převodu potenciální energie na úsporné (nezpotřebované) paliva, když vozidlo ztratí zvýšení (tj. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved je získán převodem uloženého (nespotřebovaného) paliva na energii pomocí fuelEnergyDensityInMJoulesPerLiter.

Musí být spárovány s .

Povolený rozsah hodnot je 0,0 až 1/.

Rozumné hodnoty : pro spalovací model : 0,51, pro elektrický model : 0,73
fuelEnergyDensityInMJoulesPerLiter
 query

number (double)

Určuje množství chemické energie uložené v jednom litru paliva v megajoules (MJ). Používá se ve spojení s *Účinnost parametry pro převody mezi uloženou nebo spotřebovanou energií a palivem. Například hustota energie je 34,2 MJ/l pro benzín a 35,8 MJ/l pro naftové palivo.

Tento parametr se vyžaduje, pokud je nastavený parametr *Efficiency.

Rozumné hodnoty : 34,2
hilliness
 query

InclineLevel

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.
instructionsType
 query

RouteInstructionsType

Pokud je zadáno, vrátí se pokyny. Všimněte si, že parametr instructionsType nelze použít ve spojení s routeRepresentation=none.
language
 query

string

Parametr jazyka určuje jazyk doprovodných zpráv. Správná podstatná jména (názvy ulic, náměstí atd.) se vrátí v zadaném jazyce nebo pokud není k dispozici, vrátí se v dostupném jazyce, který je blízko něj. Povolené hodnoty jsou (podmnožinou) značek jazyka IETF. Aktuálně podporované jazyky jsou uvedeny v části Podporované jazyky.

Výchozí hodnota: en-GB
maxAlternatives
 query

integer

minimum: 0
maximum: 5

Počet požadovaných alternativních tras, které se mají vypočítat. Výchozí hodnota: 0, minimum: 0 a maximum: 5
maxChargeInkWh
 query

number (double)

Určuje maximální přívod elektrické energie v kilowatthodinách (kWh), který může být uložen v baterii vozidla.

Tento parametr existuje společně s parametrem currentChargeInkWh.

Minimální hodnota musí být větší nebo rovna currentChargeInkWh.

Rozumné hodnoty : 85
minDeviationDistance
 query

integer

Všechny vrácené alternativní trasy se budou řídit referenční trasou (viz část POST Requests) z počátečního bodu požadavku calculateRoute pro alespoň tento počet měřičů. Lze použít pouze při rekonstrukci trasy. Parametr minDeviationDistance nelze použít ve spojení s funkcí arriveAt.
minDeviationTime
 query

integer

Všechny vrácené alternativní trasy se budou řídit referenční trasou (viz část POST Requests) z počátečního bodu požadavku calculateRoute alespoň na tento počet sekund. Lze použít pouze při rekonstrukci trasy. Parametr minDeviationTime nelze použít ve spojení s arriveAt. Výchozí hodnota je 0. Nastavení )minDeviationTime_ na hodnotu větší než nula má následující důsledky:

  • Počáteční bod calculateRoute Požadavek musí být na vstupní referenční trase (nebo velmi blízko).
    • Pokud tomu tak není, vrátí se chyba.
    • Počáteční bod však nemusí být na začátku vstupní referenční trasy (lze ji považovat za aktuální pozici vozidla na referenční trase).
  • Referenční trasa vrácená jako první trasa v calculateRoute Response začne v počátečním bodě zadaném v calculateRoute Request. Počáteční část vstupní referenční trasy nahoru až do doby, než bude počáteční bod vyloučen z odpovědi.
  • Hodnoty minDeviationDistance a minDeviationTime určují, jak daleko se budou alternativní trasy řídit referenční trasou od počátečního bodu dál.
  • Trasa musí používat odjezdu.
  • heading vozidel se ignoruje.
report
 query

Report

Určuje, která data se mají hlásit pro účely diagnostiky. Jedinou možnou hodnotou je effectiveSettings. Hlásí efektivní parametry nebo data použitá při volání rozhraní API. V případě výchozích parametrů se výchozí hodnota projeví tam, kde volající nezadával parametr.
routeRepresentation
 query

RouteRepresentationForBestOrder

Určuje reprezentaci sady tras zadaných jako odpověď.
routeType
 query

RouteType

Typ požadované trasy.
sectionType
 query

SectionType[]

Určuje, které typy oddílů jsou hlášeny v odpovědi trasy.

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto
traffic
 query

boolean

Možné hodnoty:

  • true – Zvažte všechny dostupné informace o provozu během směrování.
  • false – Během směrování ignorujte aktuální data provozu. Mějte na paměti, že i když se aktuální data provozu během směrování ignorují, vliv historického provozu na efektivní rychlosti silničního provozu je stále začleněn.
travelMode
 query

TravelMode

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.
uphillEfficiency
 query

number (double)

minimum: 0
maximum: 1

Určuje účinnost převodu chemické energie uložené v palivu na potenciální energii, když vozidlo získá zvýšení (tj. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed je získán převodem spotřebovaného paliva na chemickou energii pomocí fuelEnergyDensityInMJoulesPerLiter.

Musí být spárovány s sjezdovéefekce.

Rozsah povolených hodnot je 0,0 až 1/sjezdovéefekce.

Rozumné hodnoty : pro spalovací model : 0,27, pro elektrický model : 0,74
vehicleAxleWeight
 query

integer

Hmotnost na nápravu vozidla v kg. Hodnota 0 znamená, že se nebere v úvahu omezení hmotnosti na nápravu.
vehicleCommercial
 query

boolean

Zda se vozidlo používá pro komerční účely. Na některých silnicích nesmí být povolena jízda na komerčních vozidlech.
vehicleEngineType
 query

VehicleEngineType

Typ motoru vozidla. Při zadání podrobného modelu spotřeby musí být konzistentní s hodnotou vehicleEngineType.
vehicleHeading
 query

integer

minimum: 0
maximum: 359

Směrový nadpis vozidla ve stupních počínaje skutečným severem a pokračuje ve směru hodinových ručiček. Sever je 0 stupňů, východ je 90 stupňů, jih je 180 stupňů, západ je 270 stupňů. Možné hodnoty 0–359
vehicleHeight
 query

number (double)

Výška vozidla v metrech. Hodnota 0 znamená, že se omezení výšky nepovažují.
vehicleLength
 query

number (double)

Délka vozidla v metrech. Hodnota 0 znamená, že omezení délky se nepovažují.
vehicleLoadType
 query

VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.
vehicleMaxSpeed
 query

integer

Maximální rychlost vozidla v km/hodině. Maximální rychlost profilu vozidla se používá ke kontrole, zda je vozidlo povoleno na dálnicích.

  • Hodnota 0 znamená, že při plánování trasy se určí a použije příslušná hodnota pro vozidlo.

  • Během plánování trasy může být přepsána nenulová hodnota. Například aktuální tok provozu je 60 km/hodina. Pokud je maximální rychlost vozidla nastavená na 50 km/hodinu, bude směrovací motor považovat za aktuální situaci 60 km/hodinu. Pokud je maximální rychlost vozidla poskytována jako 80 km/hodina, ale aktuální tok provozu je 60 km/hodina, směrovací motor znovu použije 60 km/hodinu.
vehicleWeight
 query

integer

Hmotnost vozidla v kg.

  • Je povinné, pokud jsou nastaveny některé z parametrů efektivity.

  • Při použití v kontextu modelu consumption musí být přísně pozitivní. Zvažují se omezení hmotnosti.

  • Pokud není zadán žádný podrobný model spotřeby a hodnota hmotnosti vozidla není nulová, zvažují se omezení hmotnosti.

  • Ve všech ostatních případech se tento parametr ignoruje.

Rozumné hodnoty : pro spalovací model : 1600, pro elektrický model : 1900
vehicleWidth
 query

number (double)

Šířka vozidla v metrech. Hodnota 0 znamená, že se omezení šířky nepovažují.
windingness
 query

WindingnessLevel

Úroveň otáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-id

string

Označuje účet určený pro použití s modelem zabezpečení Microsoft Entra ID. Toto jedinečné ID pro účet Azure Maps lze získat z rozhraní API účtu roviny správy Azure Maps. Další informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v tématu Správa ověřování v Azure Maps.

Odpovědi

Name Typ Description
200 OK

RouteDirections

OK
Other Status Codes

ErrorResponse

Došlo k neočekávané chybě.

Zabezpečení

AADToken

Jedná se o Microsoft Entra OAuth 2.0 Flow. Při spárování s přístupu na základě role Azure se dá řídit přístup k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role Azure slouží k určení přístupu k jednomu nebo více účtům prostředků Nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit koncepty ověřování . Stručně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a rozsahy.

Poznámky

  • Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace žádá o přístup. To lze získat z rozhraní API pro správu Maps.

Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné adresy URL autorizace a konfigurace MICROSOFT Entra ID. * Řízení přístupu na základě role Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad AZURE SDK nebo rozhraní REST API. * Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč bezpečně uložit.

Typ: apiKey
V: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Successfully retrieve a route between an origin and a destination

Ukázkový požadavek

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

Ukázková odpověď

Stavový kód:
200 
{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definice

Name Description
AlternativeRouteType

Řídí optimální výkon vzhledem k zadaným kritériím plánování počítaných alternativ v porovnání s referenční trasou.
ComputeTravelTime

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.
DelayMagnitude

Velikost zpoždění způsobená incidentem. Tyto hodnoty odpovídají hodnotám pole odpovědi v poli Get Traffic Incident Detail API.
DrivingSide

Označuje levou vs. pravou stranu řízení v místě manévru.
EffectiveSetting

Efektivní parametr nebo data používaná při volání tohoto rozhraní API trasy
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě.
ErrorResponse

Chybová odpověď
GuidanceInstructionType

Typ instrukce, např. otáčení nebo změna silničního formuláře.
GuidanceManeuver

Kód identifikující manévr.
InclineLevel

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.
JunctionType

Typ křižovatky, ve které se manévruje. U větších kruhových objezdů se vygenerují dva samostatné pokyny pro vstup a opuštění kruhového objezdu.
LatLongPair

Umístění reprezentované jako zeměpisná šířka a zeměpisná délka
Report

Určuje, která data se mají hlásit pro účely diagnostiky. Jedinou možnou hodnotou je effectiveSettings. Hlásí efektivní parametry nebo data použitá při volání rozhraní API. V případě výchozích parametrů se výchozí hodnota projeví tam, kde volající nezadával parametr.
ResponseFormat

Požadovaný formát odpovědi Hodnota může být json nebo xml.
ResponseSectionType

Typy oddílů hlášené odpovědi na trasu
ResponseTravelMode

Režim cesty pro počítanou trasu. Hodnota se nastaví na other, pokud požadovaný režim dopravy není v této části možný.
Route
RouteAvoidType

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.
RouteDirections

Tento objekt se vrátí z úspěšného volání Směr trasy.
RouteGuidance

Obsahuje pokyny související prvky. Toto pole se nachází pouze v případě, že byly požadovány pokyny a jsou k dispozici.
RouteInstruction

Sada atributů popisujících manévr, např. "Turn right", 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.
RouteInstructionGroup

Seskupí posloupnost instrukčních prvků, které spolu vzájemně souvisejí. Rozsah sekvence je omezen s firstInstructionIndex a lastInstructionIndex. Pokud jsou textové zprávy čitelné pro člověka požadovány pro pokyny (instructionType=text nebo tagged), pak má skupina instructionGroup souhrnnou zprávu vrácenou, pokud je k dispozici.
RouteInstructionsType

Pokud je zadáno, vrátí se pokyny. Všimněte si, že parametr instructionsType nelze použít ve spojení s routeRepresentation=none.
RouteLeg

Popis části trasy, která se skládá ze seznamu bodů. Každý další směrový bod zadaný v požadavku způsobí další nohu ve vrácené trase.
RouteLegSummary

Souhrnný objekt pro oddíl trasy
RouteOptimizedWaypoint

Optimalizovaný objekt bodu cesty.
RouteReport

Zaznamenává efektivní nastavení použitá v aktuálním volání.
RouteRepresentationForBestOrder

Určuje reprezentaci sady tras zadaných jako odpověď.
RouteSection

Oddíly trasy obsahují další informace o částech trasy. Každý oddíl obsahuje alespoň prvky startPointIndex, endPointIndexa sectionType.
RouteSectionTec

Podrobnosti o události provozu pomocí definic v TPEG2-TEC standardu. Může obsahovat effectCode a způsobuje elementy.
RouteSectionTecCause

Příčina dopravní události. Může obsahovat elementy mainCauseCode a subCauseCode. Lze použít k definování ikonografie a popisů.
RouteSummary

Souhrnný objekt
RouteType

Typ požadované trasy.
SectionType

Určuje, které typy oddílů jsou hlášeny v odpovědi trasy.

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto
SimpleCategory

Typ incidentu. V současné době může být JAM, ROAD_WORK, ROAD_CLOSURE nebo OTHER. Podrobné informace naleznete v tématu "tec".
TravelMode

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.
VehicleEngineType

Typ motoru vozidla. Při zadání podrobného modelu spotřeby musí být konzistentní s hodnotou vehicleEngineType.
VehicleLoadType

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.
WindingnessLevel

Úroveň otáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

AlternativeRouteType

Výčet

Řídí optimální výkon vzhledem k zadaným kritériím plánování počítaných alternativ v porovnání s referenční trasou.

Hodnota Description
anyRoute

Povolit vrácení jakékoli alternativní trasy bez ohledu na to, jak se porovná s referenční trasou z hlediska optimálního výkonu.
betterRoute

Alternativní trasu vraťte pouze v případě, že je lepší než referenční trasa podle zadaných kritérií plánování.

ComputeTravelTime

Výčet

Určuje, jestli se mají vrátit další doby cesty pomocí různých typů informací o provozu (žádné, historické, živé) a výchozí doby jízdy s nejlepším odhadem.

Hodnota Description
none

Nevypočítá další doby cestování.
all

Vypočítá dobu cesty pro všechny typy informací o provozu a určuje všechny výsledky v polích noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds a liveTrafficIncidentsTravelTimeInSeconds zahrnuté do souhrnů v odpovědi trasy.

DelayMagnitude

Výčet

Velikost zpoždění způsobená incidentem. Tyto hodnoty odpovídají hodnotám pole odpovědi v poli Get Traffic Incident Detail API.

Hodnota Description
0

Neznámý.
1

Moll.
2

Moderovat.
3

Major.
4

Nedefinováno, používáno pro uzavření silnic a další neomezená zpoždění.

DrivingSide

Výčet

Označuje levou vs. pravou stranu řízení v místě manévru.

Hodnota Description
LEFT

Levá strana.
RIGHT

Líc.

EffectiveSetting

Objekt

Efektivní parametr nebo data používaná při volání tohoto rozhraní API trasy

Name Typ Description
key

string

Název použitého parametru
value

string

Hodnota použitého parametru

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

GuidanceInstructionType

Výčet

Typ instrukce, např. otáčení nebo změna silničního formuláře.

Hodnota Description
TURN

Obrátit.
ROAD_CHANGE

Změna cesty.
LOCATION_DEPARTURE

Místo odjezdu.
LOCATION_ARRIVAL

Místo příjezdu.
DIRECTION_INFO

Informace o směru.
LOCATION_WAYPOINT

Umístění bodu cesty.

GuidanceManeuver

Výčet

Kód identifikující manévr.

Hodnota Description
ARRIVE

Přijel jsi.
ARRIVE_LEFT

Přijel jsi. Cíl je na levé straně.
ARRIVE_RIGHT

Přijel jsi. Váš cíl je na pravé straně.
DEPART

Odjet.
STRAIGHT

Držte se rovnou.
KEEP_RIGHT

Držte se správně.
BEAR_RIGHT

Noste právo.
TURN_RIGHT

Zatočit doprava.
SHARP_RIGHT

Otápět doprava.
KEEP_LEFT

Držte se doleva.
BEAR_LEFT

Medvěd zbyl.
TURN_LEFT

Zatočit doleva.
SHARP_LEFT

Otočte se doleva.
MAKE_UTURN

Nastavte U-turn.
ENTER_MOTORWAY

Vezmi si dálnici.
ENTER_FREEWAY

Vezmi si volný chodník.
ENTER_HIGHWAY

Vezmi si dálnici.
TAKE_EXIT

Vezmi si východ.
MOTORWAY_EXIT_LEFT

Jděte doleva.
MOTORWAY_EXIT_RIGHT

Vezmi pravý konec.
TAKE_FERRY

Vezmi trajekt.
ROUNDABOUT_CROSS

Přes kruhový objezd.
ROUNDABOUT_RIGHT

V kruhovém kruhovém objezdu vystupte na pravé straně.
ROUNDABOUT_LEFT

V kruhovém kruhovém objezdu vyjíždět nalevo.
ROUNDABOUT_BACK

Běž kolem kruhového objezdu.
TRY_MAKE_UTURN

Zkuste udělat U-turn.
FOLLOW

Následovat.
SWITCH_PARALLEL_ROAD

Přepněte na paralelní cestu.
SWITCH_MAIN_ROAD

Přejděte na hlavní silnici.
ENTRANCE_RAMP

Vezmi rampu.
WAYPOINT_LEFT

Dosáhli jste směrového bodu. Je na levé straně.
WAYPOINT_RIGHT

Dosáhli jste směrového bodu. Je na pravé straně.
WAYPOINT_REACHED

Dosáhli jste směrového bodu.

InclineLevel

Výčet

Stupeň kopcovitosti pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

Hodnota Description
low

nízký
normal

normální
high

vysoko

JunctionType

Výčet

Typ křižovatky, ve které se manévruje. U větších kruhových objezdů se vygenerují dva samostatné pokyny pro vstup a opuštění kruhového objezdu.

Hodnota Description
REGULAR

pravidelný
ROUNDABOUT

kruhový objezd
BIFURCATION

bifurkace

LatLongPair

Objekt

Umístění reprezentované jako zeměpisná šířka a zeměpisná délka

Name Typ Description
latitude

number (double)

Vlastnost Zeměpisná šířka
longitude

number (double)

Zeměpisná délka – vlastnost

Report

Výčet

Určuje, která data se mají hlásit pro účely diagnostiky. Jedinou možnou hodnotou je effectiveSettings. Hlásí efektivní parametry nebo data použitá při volání rozhraní API. V případě výchozích parametrů se výchozí hodnota projeví tam, kde volající nezadával parametr.

Hodnota Description
effectiveSettings

Hlásí efektivní parametry nebo data použitá při volání rozhraní API.

ResponseFormat

Výčet

Požadovaný formát odpovědi Hodnota může být json nebo xml.

Hodnota Description
json

formát výměny dat javascriptového objektu
xml

rozšiřitelného jazyka značek

ResponseSectionType

Výčet

Typy oddílů hlášené odpovědi na trasu

Hodnota Description
CAR_TRAIN

Oddíly trasy, které jsou auty nebo vlaky.
COUNTRY

Oddíly označující, ve kterých zemích nebo oblastech trasa je.
FERRY

Úseky trasy, které jsou trajekty.
MOTORWAY

Úseky trasy, které jsou dálnicemi.
PEDESTRIAN

Úseky trasy, které jsou vhodné pouze pro chodce.
TOLL_ROAD

Oddíly trasy, které vyžadují placení placené linky.
TOLL_VIGNETTE

Oddíly trasy, které vyžadují, aby byla přítomna bezplatná dálniční známka.
TRAFFIC

Oddíly trasy, které obsahují informace o provozu
TRAVEL_MODE

Oddíly týkající se parametru požadavku travelMode.
TUNNEL

Oddíly trasy, které jsou tunely.
CARPOOL

Úseky trasy, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle( HOV/ High Occupancy Vehicle).
URBAN

Úseky trasy, které se nacházejí v městských oblastech.

ResponseTravelMode

Výčet

Režim cesty pro počítanou trasu. Hodnota se nastaví na other, pokud požadovaný režim dopravy není v této části možný.

Hodnota Description
car

Vrácené trasy jsou optimalizované pro auta.
truck

Vrácené trasy jsou optimalizované pro komerční vozidla, jako jsou nákladní vozy.
taxi

Vrácené trasy jsou optimalizované pro taxislužby. Funkce BETA.
bus

Vrácené trasy jsou optimalizované pro autobusy, včetně použití pouze jízdních pruhů. Funkce BETA.
van

Vrácené trasy jsou optimalizované pro dodávky. Funkce BETA.
motorcycle

Vrácené trasy jsou optimalizované pro motocykly. Funkce BETA.
bicycle

Vrácené trasy jsou optimalizované pro jízdní kola, včetně použití jízdních pruhů.
pedestrian

Vrácené trasy jsou optimalizované pro chodce, včetně použití chodníků.
other

Daný způsob dopravy není v této části možný.

Route

Objekt
Name Typ Description
guidance

RouteGuidance

Obsahuje pokyny související prvky. Toto pole se nachází pouze v případě, že byly požadovány pokyny a jsou k dispozici.
legs

RouteLeg[]

Pole nohou
sections

RouteSection[]

Pole oddílů
summary

RouteSummary

Souhrnný objekt

RouteAvoidType

Výčet

Určuje něco, čeho se má výpočet trasy při určování trasy pokusit vyhnout. V jedné žádosti je možné zadat vícekrát, například "&se vyhnout =dálnice&vyhnout=tollRoads&vyhnout se =trajekty". V požadavcích rozsahu tras se hodnota alreadyUsedRoads nesmí použít.

Hodnota Description
tollRoads

Vyhněte se silničním poplatkům.
motorways

Vyhněte se dálnicm
ferries

Vyhněte se trajektům
unpavedRoads

Vyhněte se neprůpavným cestám.
carpools

Vyhněte se trasám, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle.
alreadyUsedRoads

Nepoužívejte stejnou silnici vícekrát. Nejužitečnější ve spojení s routeType=vzrušující.
borderCrossings

Vyhne se překračování hranic při výpočtu trasy.

RouteDirections

Objekt

Tento objekt se vrátí z úspěšného volání Směr trasy.

Name Typ Description
formatVersion

string

Vlastnost Format Version
optimizedWaypoints

RouteOptimizedWaypoint[]

Optimalizovaná posloupnost waypointů. Zobrazuje index od uživatelem poskytnuté sekvence waypointu pro původní a optimalizovaný seznam. Například odpověď:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

znamená, že původní sekvence je [0, 1, 2] a optimalizovaná sekvence je [1, 2, 0]. Vzhledem k tomu, že index začíná 0, původní je "první, druhý, třetí", zatímco optimalizovaný je "druhý, třetí, první".
report

RouteReport

Zaznamenává efektivní nastavení použitá v aktuálním volání.
routes

Route[]

Pole Tras

RouteGuidance

Objekt

Obsahuje pokyny související prvky. Toto pole se nachází pouze v případě, že byly požadovány pokyny a jsou k dispozici.

Name Typ Description
instructionGroups

RouteInstructionGroup[]

Seskupí posloupnost instrukčních prvků, které spolu vzájemně souvisejí.
instructions

RouteInstruction[]

Seznam instrukcí popisujících manévry.

RouteInstruction

Objekt

Sada atributů popisujících manévr, např. "Turn right", 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

Name Typ Description
combinedMessage

string

Člověkem čitelný vzkaz pro manévr v kombinaci se zprávou z další instrukce. Někdy je možné zkombinovat dva následné instrukce do jedné instrukce, což usnadňuje sledování. Pokud je to případ možnéCombineWithNext příznak bude true. Například:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

Možný PříznakCombineWithNext u instrukce 10 je pravdivý. To znamená klientům kódovaných pokynů, že je možné je kombinovat s instrukcí 11. Pokyny se automaticky zkombinují pro klienty, kteří požadují pokyny čitelné pro člověka. Kombinované poleMessage obsahuje kombinovanou zprávu:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

3znakový ISO 3166-1 kód země alfa-3. Např. USA.
drivingSide

DrivingSide

Označuje levou vs. pravou stranu řízení v místě manévru.
exitNumber

string

Čísla dálničního výstupu pořízeného aktuálním manévrem. Pokud má výstup více výstupních čísel, oddělí je "," a případně se agreguje podle "-", například "10, 13-15".
instructionType

GuidanceInstructionType

Typ instrukce, např. otáčení nebo změna silničního formuláře.
junctionType

JunctionType

Typ křižovatky, ve které se manévruje. U větších kruhových objezdů se vygenerují dva samostatné pokyny pro vstup a opuštění kruhového objezdu.
maneuver

GuidanceManeuver

Kód identifikující manévr.
message

string

Člověkem čitelný vzkaz pro manévr.
point

LatLongPair

Umístění reprezentované jako zeměpisná šířka a zeměpisná délka
pointIndex

integer

Index bodu v seznamu "bodů" odpovídající bodu instrukce.
possibleCombineWithNext

boolean

Volitelně je možné zkombinovat instrukce s další. Dá se použít k vytváření zpráv, jako je "Turn left and then turn right".
roadNumbers

string[]

Čísla silnic dalšího významného silničního úseku po manévru nebo silničních cest, které mají být sledovány. Příklad: ["E34", "N205"]
roundaboutExitNumber

integer (int64)

Označuje, který východ se má provést v kruhovém objezdu.
routeOffsetInMeters

integer

Vzdálenost od začátku trasy k bodu instrukce.
signpostText

string

Text na značce, který je pro manévr nejrelevavantnější, nebo ke směru, který by měl následovat.
stateCode

string

Dílčí rozdělení (např. stát) země reprezentované druhou částí iso 3166-2 kódu. Tato možnost je dostupná jenom pro některé země nebo oblasti, jako jsou USA, Kanada a Mexiko.
street

string

Název ulice dalšího významného úseku silnice po manévru nebo ulici, která by měla následovat.
travelTimeInSeconds

integer

Odhadovaná doba trvání cesty až do bodu odpovídajícího traseOffsetInMeters.
turnAngleInDecimalDegrees

integer

Určuje směr instrukce. Pokud junctionType indikuje instrukci turn:

  • 180 = Otočka do protisměru
  • [-179, -1] = Levá otočka
  • 0 = přímka (otočení "0 stupňů")
  • [1, 179] = Pravý otoč

Pokud junctionType indikuje instrukci bifurcation:

  • <0 – ponechat vlevo
  • >0 – držte pravdu

RouteInstructionGroup

Objekt

Seskupí posloupnost instrukčních prvků, které spolu vzájemně souvisejí. Rozsah sekvence je omezen s firstInstructionIndex a lastInstructionIndex. Pokud jsou textové zprávy čitelné pro člověka požadovány pro pokyny (instructionType=text nebo tagged), pak má skupina instructionGroup souhrnnou zprávu vrácenou, pokud je k dispozici.

Name Typ Description
firstInstructionIndex

integer

Index první instrukce v pokynech a patřící do této skupiny.
groupLengthInMeters

integer

Délka skupiny
groupMessage

string

Souhrnná zpráva v případě, že jsou požadovány textové zprávy čitelné pro člověka (instructionType=text nebo označené).
lastInstructionIndex

integer

Index poslední instrukce v pokynech a patřící do této skupiny

RouteInstructionsType

Výčet

Pokud je zadáno, vrátí se pokyny. Všimněte si, že parametr instructionsType nelze použít ve spojení s routeRepresentation=none.

Hodnota Description
coded

Vrátí nezpracovaná data instrukcí bez čitelných zpráv.
text

Vrátí nezpracovaná data instrukcí se zprávami čitelnými lidmi v prostém textu.
tagged

Vrátí nezpracovaná instrukční data se značkami čitelnými lidmi, aby bylo možné formátování povolit. Zpráva čitelná pro člověka je vytvořena z opakovatelných identifikovaných prvků. Jsou označené tak, aby klientské aplikace mohly správně formátovat. Následující součásti zprávy jsou označené, když instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Příklad označené zprávy "Turn left" (Zleva):

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

RouteLeg

Objekt

Popis části trasy, která se skládá ze seznamu bodů. Každý další směrový bod zadaný v požadavku způsobí další nohu ve vrácené trase.

Name Typ Description
points

LatLongPair[]

Pole bodů
summary

RouteLegSummary

Souhrnný objekt pro oddíl trasy

RouteLegSummary

Objekt

Souhrnný objekt pro oddíl trasy

Name Typ Description
arrivalTime

string (date-time)

Odhadovaná doba příjezdu pro trasu nebo nohu. Čas je ve standardu UTC.
batteryConsumptionInkWh

number (double)

Odhadovaná spotřeba elektrické energie v kilowatthodinách (kWh) pomocí modelu elektrické spotřeby. Zahrnuto, pokud je vozidloEngineType nastaveno na elektrické a konstantníSpeedConsumptionInkWhPerHundredkm je zadán. Hodnota baterieConsumptionInkWh zahrnuje recupe jmenovitou elektrickou energii, a proto může být negativní (což označuje získání energie). Pokud jsou zadány hodnoty maxChargeInkWh i currentChargeInkWh, bude rekuperace omezena, aby se zajistilo, že úroveň nabití baterie nikdy nepřekročí maxChargeInkWh. Pokud není zadána hodnota maxChargeInkWh ani currentChargeInkWh, předpokládá se ve výpočtu spotřeby nevyučovaná rekuperace.
departureTime

string (date-time)

Odhadovaná doba odletu pro trasu nebo nohu. Čas je ve standardu UTC.
fuelConsumptionInLiters

number (double)

Odhadovaná spotřeba paliva v literech pomocí modelu spotřeby spalování. Zahrnuto, pokud je vozidloEngineType nastaveno na spalování a constantSpeedConsumptionInLitersPerHundredkm je zadán. Hodnota bude nezáporná.
historicTrafficTravelTimeInSeconds

integer

Odhadovaná doba jízdy vypočítaná pomocí historických dat historického provozu závislých na čase. Zahrnuté pouze v případě, že se v dotazu používá computeTravelTimeFor = vše.
lengthInMeters

integer

Vlastnost Délka v metrech
liveTrafficIncidentsTravelTimeInSeconds

integer

Odhadovaná doba jízdy vypočítaná pomocí dat o rychlosti v reálném čase Zahrnuté pouze v případě, že se v dotazu používá computeTravelTimeFor = vše.
noTrafficTravelTimeInSeconds

integer

Odhadovaná doba jízdy vypočítaná tak, jako kdyby nedošlo k žádným zpožděním na trase kvůli dopravním podmínkám (např. zahlcení). Zahrnuté pouze v případě, že se v dotazu používá computeTravelTimeFor = vše.
trafficDelayInSeconds

integer

Odhadované zpoždění v sekundách způsobené incidenty v reálném čase podle informací o provozu. U tras plánovaných s časem odletu v budoucnu jsou zpoždění vždy 0. Pokud chcete vrátit další doby cesty pomocí různých typů informací o provozu, je potřeba přidat parametr computeTravelTimeFor=all.
travelTimeInSeconds

integer

Odhadovaná doba trvání cesty ve vlastnosti sekund, která zahrnuje zpoždění kvůli provozu v reálném čase. Mějte na paměti, že i když traffic=false travelTimeInSeconds stále zahrnuje zpoždění kvůli provozu. Pokud je funkce DepartAt v budoucnu, doba jízdy se vypočítá pomocí historických dat o provozu závislých na čase.

RouteOptimizedWaypoint

Objekt

Optimalizovaný objekt bodu cesty.

Name Typ Description
optimizedIndex

integer

Optimalizovaný index bodu bodu ze systému.
providedIndex

integer

Index bodu cesty poskytnutý uživatelem

RouteReport

Objekt

Zaznamenává efektivní nastavení použitá v aktuálním volání.

Name Typ Description
effectiveSettings

EffectiveSetting[]

Efektivní parametry nebo data používaná při volání tohoto rozhraní API trasy

RouteRepresentationForBestOrder

Výčet

Určuje reprezentaci sady tras zadaných jako odpověď.

Hodnota Description
polyline

Zahrnuje geometrii trasy v odpovědi.
summaryOnly

Souhrn podle křivky, ale s výjimkou prvků geometrie bodu pro trasy v odpovědi.
none

Zahrnuje pouze optimalizované indexy směrových bodů, ale nezahrnuje geometrii trasy v odpovědi. Tuto hodnotu parametru lze použít pouze ve spojení s computeBestOrder=true.

RouteSection

Objekt

Oddíly trasy obsahují další informace o částech trasy. Každý oddíl obsahuje alespoň prvky startPointIndex, endPointIndexa sectionType.

Name Typ Description
delayInSeconds

integer

Zpoždění v sekundách způsobené incidentem
effectiveSpeedInKmh

integer

Efektivní rychlost incidentu v km/h, v průměru přes celou jeho délku.
endPointIndex

integer

Index posledního bodu (posun 0) na trase, na které se tento oddíl vztahuje.
magnitudeOfDelay

DelayMagnitude

Velikost zpoždění způsobená incidentem. Tyto hodnoty odpovídají hodnotám pole odpovědi v poli Get Traffic Incident Detail API.
sectionType

ResponseSectionType

Typy oddílů hlášené odpovědi na trasu
simpleCategory

SimpleCategory

Typ incidentu. V současné době může být JAM, ROAD_WORK, ROAD_CLOSURE nebo OTHER. Podrobné informace naleznete v tématu "tec".
startPointIndex

integer

Index prvního bodu (posunu 0) na trase, na které se tento oddíl vztahuje.
tec

RouteSectionTec

Podrobnosti o události provozu pomocí definic v TPEG2-TEC standardu. Může obsahovat effectCode a způsobuje elementy.
travelMode

ResponseTravelMode

Režim cesty pro počítanou trasu. Hodnota se nastaví na other, pokud požadovaný režim dopravy není v této části možný.

RouteSectionTec

Objekt

Podrobnosti o události provozu pomocí definic v TPEG2-TEC standardu. Může obsahovat effectCode a způsobuje elementy.

Name Typ Description
causes

RouteSectionTecCause[]

Příčiny pole
effectCode

integer

Vliv na tok provozu. Obsahuje hodnotu v tabulce tec001:EffectCode, jak je definováno v TPEG2-TEC standardu. Lze použít k barevnému kódování událostí provozu v závislosti na závažnosti.

RouteSectionTecCause

Objekt

Příčina dopravní události. Může obsahovat elementy mainCauseCode a subCauseCode. Lze použít k definování ikonografie a popisů.

Name Typ Description
mainCauseCode

integer

Hlavní příčinou dopravní události. Obsahuje hodnotu v tabulce tec002:CauseCode, jak je definováno v TPEG2-TEC standardu.
subCauseCode

integer

Podkaus události provozu. Obsahuje hodnotu v tabulce dílčí příčiny definovanou mainCauseCode, jak je definováno v TPEG2-TEC standardu.

RouteSummary

Objekt

Souhrnný objekt

Name Typ Description
arrivalTime

string (date-time)

Odhadovaná doba příjezdu pro trasu nebo nohu. Čas je ve standardu UTC.
departureTime

string (date-time)

Odhadovaná doba odletu pro trasu nebo nohu. Čas je ve standardu UTC.
lengthInMeters

integer

Vlastnost Délka v metrech
trafficDelayInSeconds

integer

Odhadované zpoždění v sekundách způsobené incidenty v reálném čase podle informací o provozu. U tras plánovaných s časem odletu v budoucnu jsou zpoždění vždy 0. Pokud chcete vrátit další doby cesty pomocí různých typů informací o provozu, je potřeba přidat parametr computeTravelTimeFor=all.
travelTimeInSeconds

integer

Odhadovaná doba trvání cesty ve vlastnosti sekund, která zahrnuje zpoždění kvůli provozu v reálném čase. Mějte na paměti, že i když traffic=false travelTimeInSeconds stále zahrnuje zpoždění kvůli provozu. Pokud je funkce DepartAt v budoucnu, doba jízdy se vypočítá pomocí historických dat o provozu závislých na čase.

RouteType

Výčet

Typ požadované trasy.

Hodnota Description
fastest

Nejrychlejší trasa.
shortest

Nejkratší trasa podle vzdálenosti.
eco

Trasa vyvážená ekonomikou a rychlostí.
thrilling

Zahrnuje zajímavé nebo náročné silnice a využívá co nejvíce dálnic. Můžete zvolit úroveň otáček včetně a také stupeň kopcovitosti. Podívejte se na parametry kopcovitosti a vinutí, jak to nastavit. Na trasách plánovaných s routeType=vzrušující je limit 900 km.

SectionType

Výčet

Určuje, které typy oddílů jsou hlášeny v odpovědi trasy.

Pokud je například sectionType = chodci, které jsou vhodné pouze pro chodce, jsou vráceny. V jednom požadavku lze zadat vícekrát, například '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. Výchozí sectionType odkazuje na vstup travelMode. Ve výchozím nastavení je travelMode nastaveno na auto

Hodnota Description
carTrain

Oddíly trasy, které jsou auty nebo vlaky.
country

Oddíly označující, ve kterých zemích nebo oblastech trasa je.
ferry

Úseky trasy, které jsou trajekty.
motorway

Úseky trasy, které jsou dálnicemi.
pedestrian

Úseky trasy, které jsou vhodné pouze pro chodce.
tollRoad

Oddíly trasy, které vyžadují uhrazení placené linky.
tollVignette

Oddíly trasy, které vyžadují, aby byla přítomna bezplatná dálniční známka.
traffic

Oddíly trasy, které obsahují informace o provozu
travelMode

Oddíly týkající se parametru požadavku travelMode.
tunnel

Oddíly trasy, které jsou tunely.
carpool

Úseky trasy, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle( HOV/ High Occupancy Vehicle).
urban

Úseky trasy, které se nacházejí v městských oblastech.

SimpleCategory

Výčet

Typ incidentu. V současné době může být JAM, ROAD_WORK, ROAD_CLOSURE nebo OTHER. Podrobné informace naleznete v tématu "tec".

Hodnota Description
JAM

Dopravní zácpa.
ROAD_WORK

Silniční práce.
ROAD_CLOSURE

Uzavírací cesta.
OTHER

Jiný.

TravelMode

Výčet

Režim cesty pro požadovanou trasu Pokud není definováno, výchozí hodnota je "auto". Všimněte si, že požadovaný travelMode nemusí být k dispozici pro celou trasu. Pokud požadovaný travelMode není pro určitou část k dispozici, bude prvek travelMode odpovědi pro tento oddíl "jiný". Všimněte si, že cestovní režimy autobus, motocykl, taxi a dodávka jsou funkce BETA. Úplná data omezení nejsou dostupná ve všech oblastech.

Hodnota Description
car

Vrácené trasy jsou optimalizované pro auta.
truck

Vrácené trasy jsou optimalizované pro komerční vozidla, jako jsou nákladní vozy.
taxi

Vrácené trasy jsou optimalizované pro taxislužby. Funkce BETA.
bus

Vrácené trasy jsou optimalizované pro autobusy, včetně použití pouze jízdních pruhů. Funkce BETA.
van

Vrácené trasy jsou optimalizované pro dodávky. Funkce BETA.
motorcycle

Vrácené trasy jsou optimalizované pro motocykly. Funkce BETA.
bicycle

Vrácené trasy jsou optimalizované pro jízdní kola, včetně použití jízdních pruhů.
pedestrian

Vrácené trasy jsou optimalizované pro chodce, včetně použití chodníků.

VehicleEngineType

Výčet

Typ motoru vozidla. Při zadání podrobného modelu spotřeby musí být konzistentní s hodnotou vehicleEngineType.

Hodnota Description
combustion

Spalovací motor.
electric

Elektrický motor.

VehicleLoadType

Výčet

Typy nákladu, které mohou být klasifikovány jako nebezpečné materiály a omezeny na některé silnice. Dostupné hodnoty vehicleLoadType jsou us Hazmat třídy 1 až 9 a obecné klasifikace pro použití v jiných zemích/oblastech. Hodnoty začínající usHazmat jsou určené pro směrování v USA, zatímco ostatníhazmat by se měly používat pro všechny ostatní země/oblasti. vehicleLoadType lze zadat vícekrát. Tento parametr je aktuálně považován pouze za travelMode=truck.

Hodnota Description
USHazmatClass1

Výbušniny
USHazmatClass2

Stlačený plyn
USHazmatClass3

Hořlavé kapaliny
USHazmatClass4

Hořlavé pevné látky
USHazmatClass5

Oxidační činidla
USHazmatClass6

Jedy
USHazmatClass7

Radioaktivní
USHazmatClass8

Corrosives
USHazmatClass9

Různé
otherHazmatExplosive

Výbušniny
otherHazmatGeneral

Různé
otherHazmatHarmfulToWater

Škodlivé pro vodu

WindingnessLevel

Výčet

Úroveň otáček pro vzrušující trasu. Tento parametr lze použít pouze ve spojení s routeType=vzrušující.

Hodnota Description
low

nízký
normal

normální
high

vysoko