Route - Post Route Directions Batch Sync

Služba:

Maps

Verze rozhraní API:

1.0

Slouží k odeslání dávky dotazů do rozhraní API Get Route Directions v jednom synchronním požadavku.

Rozhraní Post Route Directions Batch Sync API je požadavek HTTP POST , který odesílá dávky dotazů do rozhraní API Get Route Directions pomocí jednoho synchronního požadavku. Můžete volat Route Directions Batch rozhraní API pro asynchronní spuštění (asynchronní) nebo synchronně (synchronizace). Asynchronní rozhraní API umožňuje volajícímu dávkovat až 700 dotazů a synchronizovat rozhraní API až 100 dotazů. Pokud chcete volat Post Route Directions Batch rozhraní API v asynchronním požadavku, přečtěte si téma Dávka pokynů pro odeslání trasy.

Odeslání synchronní dávkové žádosti

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, zareaguje hned po výpočtu dávkových položek a nebude možné později načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je pro toto rozhraní API omezený na 100 .

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Model dávkové odpovědi

Vrácený datový obsah se podobá asynchronním a synchronizačním požadavkům. Pokud se při stahování výsledků asynchronní dávkové žádosti dokončilo zpracování dávky, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje komponentu summarytotalRequests , která označuje, které byly součástí původního dávkového požadavku, a successfulRequeststj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje batchItems také pole, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. Bude batchItems obsahovat výsledky v přesně stejném pořadí, v jakém byly původní dotazy odeslány v dávkovém požadavku. Každá položka v batchItems souboru obsahuje statusCode pole a response . Každý response v batchItems systému má jeden z následujících typů:

• RouteDirections – Pokud se dotaz úspěšně dokončil.

• Error – Pokud dotaz selhal. Odpověď bude v tomto případě obsahovat a code .message

Tady je ukázka dávkové odpovědi s 1 úspěšným a 1 neúspěšným výsledkem:

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
format	path	True	JsonFormat	Požadovaný formát odpovědi. Podporuje se pouze json formát.
api-version	query	True	string	Číslo verze rozhraní API služby Azure Maps

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích .

Text požadavku

Name	Typ	Description
batchItems	BatchRequestItem[]	Seznam dotazů ke zpracování.

Odpovědi

Name	Typ	Description
200 OK	RouteDirectionsBatchResult	OK
Other Status Codes	ErrorResponse	Vypršení časového limitu: Dokončení požadavku trvalo déle, než je maximální doba definovaná v rozhraní API.
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním Azure Maps REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika úč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 několika oprávnění k rozhraním REST API služby Azure Maps.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně ř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 obory.

Poznámky

• Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v 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í sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

• Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.

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 vytváření účtu Azure Maps na webu Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem může každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme použít pro přístup k rozhraním REST API služby Azure Maps přístup k důvěrným klientským aplikacím , aby se váš klíč mohl 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 List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK 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 v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné 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ů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Typ: apiKey
V: header

Příklady

Successfully retrieve the route direction batch result synchronously

Ukázkový požadavek

HTTP

POST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
    },
    {
      "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
    },
    {
      "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
    }
  ]
}

Ukázková odpověď

Stavový kód:

200

{
  "batchItems": [
    {
      "statusCode": 400,
      "response": {
        "error": {
          "code": "400 BadRequest",
          "message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
        }
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1754,
              "travelTimeInSeconds": 386,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:02:49+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1754,
                  "travelTimeInSeconds": 386,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:02:49+00:00"
                },
                "points": [
                  {
                    "latitude": 47.62094,
                    "longitude": -122.34892
                  },
                  {
                    "latitude": 47.62094,
                    "longitude": -122.3485
                  },
                  {
                    "latitude": 47.62095,
                    "longitude": -122.3476
                  },
                  {
                    "latitude": 47.60995,
                    "longitude": -122.34174
                  },
                  {
                    "latitude": 47.61011,
                    "longitude": -122.342
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 44,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "bicycle"
              }
            ]
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "formatVersion": "0.0.12",
        "routes": [
          {
            "summary": {
              "lengthInMeters": 1772,
              "travelTimeInSeconds": 1276,
              "trafficDelayInSeconds": 0,
              "departureTime": "2019-06-21T22:56:23+00:00",
              "arrivalTime": "2019-06-21T23:17:38+00:00"
            },
            "legs": [
              {
                "summary": {
                  "lengthInMeters": 1772,
                  "travelTimeInSeconds": 1276,
                  "trafficDelayInSeconds": 0,
                  "departureTime": "2019-06-21T22:56:23+00:00",
                  "arrivalTime": "2019-06-21T23:17:38+00:00"
                },
                "points": [
                  {
                    "latitude": 40.75982,
                    "longitude": -73.98493
                  },
                  {
                    "latitude": 40.7601,
                    "longitude": -73.98483
                  },
                  {
                    "latitude": 40.75984,
                    "longitude": -73.98417
                  },
                  {
                    "latitude": 40.76047,
                    "longitude": -73.9837
                  },
                  {
                    "latitude": 40.77095,
                    "longitude": -73.9736
                  },
                  {
                    "latitude": 40.77114,
                    "longitude": -73.97356
                  }
                ]
              }
            ],
            "sections": [
              {
                "startPointIndex": 0,
                "endPointIndex": 47,
                "sectionType": "TRAVEL_MODE",
                "travelMode": "pedestrian"
              }
            ]
          }
        ]
      }
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 3
  }
}

Stavový kód:

408

{
  "error": {
    "code": "408 Timeout",
    "message": "Timeout: The request took longer to finish than the maximum amount of time defined in the api."
  }
}

Definice

Name	Description
BatchRequest	Tento typ představuje text požadavku pro službu Batch.
BatchRequestItem	Objekt požadavku služby Batch
DelayMagnitude	Velikost zpoždění způsobeného incidentem. Tyto hodnoty odpovídají hodnotám pole odpovědi ty rozhraní API Get Traffic Incident Detail.
DrivingSide	Označuje jízdu vlevo nebo vpravo v místě manévru.
EffectiveSetting	Efektivní parametr nebo data použitá při volání tohoto rozhraní API směrování
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
GuidanceInstructionType	Typ instrukce, např. otočení nebo změna jízdního formuláře.
GuidanceManeuver	Kód identifikující manévr.
JsonFormat	Požadovaný formát odpovědi. Podporuje se pouze json formát.
JunctionType	Typ spojení, kde se manévr provádí. Pro větší kruhové objezdy jsou generovány dva samostatné pokyny pro vstup a odchod z kruhového objezdu.
LatLongPair	Umístění reprezentované jako zeměpisná šířka a délka.
Response	Výsledek dotazu. RouteDirections, pokud se dotaz úspěšně dokončil, ErrorResponse v opačném případě.
ResponseSectionType	Typy oddílů hlášené trasy
ResponseTravelMode	Cestovní režim pro počítanou trasu. Hodnota se nastaví na other , pokud požadovaný způsob dopravy není v této části možný.
Route
RouteDirectionsBatchItem	Položka vrácená z volání služby Batch route Directions.
RouteDirectionsBatchResult	Tento objekt se vrátí z úspěšného volání služby Batch směr trasy.
RouteGuidance	Obsahuje prvky související s pokyny. Toto pole je k dispozici pouze v případě, že bylo požadováno doprovodné materiály a je k dispozici.
RouteInstruction	Sada atributů popisujících manévr, např. "Zatáčkejte doprava", "Keep left", "Take the ferry", "Take the motorway", "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 pro pokyny požadovány textové zprávy čitelné pro člověka (instructionType=text nebo tagged), vrátí se do skupiny instructionGroup souhrnná zpráva, pokud je k dispozici.
RouteLeg	Popis části trasy, která se skládá ze seznamu bodů. Každý další směrový bod zadaný v požadavku bude mít za následek další úsek ve vrácené trase.
RouteLegSummary	Souhrnný objekt pro oddíl trasy.
RouteOptimizedWaypoint	Optimalizovaný objekt bodu cesty.
RouteReport	Hlásí platná nastavení použitá v aktuálním volání.
RouteSection	Oddíly tras obsahují další informace o částech trasy. Každý oddíl obsahuje alespoň elementy startPointIndex, endPointIndexa sectionType.
RouteSectionTec	Podrobnosti o události provozu pomocí definic ve standardu TPEG2-TEC Může obsahovat elementy effectCode a způsobuje.
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
SimpleCategory	Typ incidentu. V současné době může být JAM, ROAD_WORK, ROAD_CLOSURE nebo JINÉ. Podrobné informace najdete v části "tec".
Summary	Souhrn výsledků dávkové žádosti

BatchRequest

Tento typ představuje text požadavku pro službu Batch.

Name	Typ	Description
batchItems	BatchRequestItem[]	Seznam dotazů ke zpracování

BatchRequestItem

Objekt požadavku služby Batch

Name	Typ	Description
query	string	Tento parametr obsahuje řetězec dotazu, který se používá k provedení nestrukturované operace geografického kódování. Řetězec dotazu se předá doslovně do vyhledávacího rozhraní API ke zpracování.

DelayMagnitude

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

Name	Typ	Description
0	string	Neznámý
1	string	Moll.
2	string	Střední.
3	string	Major.
4	string	Nedefinované, používané pro uzavírky silnic a jiná neomezená zpoždění.

DrivingSide

Označuje jízdu vlevo nebo vpravo v místě manévru.

Name	Typ	Description
LEFT	string	Levá strana.
RIGHT	string	Líc.

EffectiveSetting

Efektivní parametr nebo data použitá při volání tohoto rozhraní API směrování

Name	Typ	Description
key	string	Název použitého parametru
value	string	Hodnota použitého parametru

ErrorAdditionalInfo

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

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

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GuidanceInstructionType

Typ instrukce, např. otočení nebo změna jízdního formuláře.

Name	Typ	Description
DIRECTION_INFO	string	Informace o směru.
LOCATION_ARRIVAL	string	Místo příjezdu.
LOCATION_DEPARTURE	string	Místo odjezdu.
LOCATION_WAYPOINT	string	Umístění bodu cesty.
ROAD_CHANGE	string	Změna cesty.
TURN	string	Obrátit.

GuidanceManeuver

Kód identifikující manévr.

Name	Typ	Description
ARRIVE	string	Přišli jste.
ARRIVE_LEFT	string	Přišli jste. Cíl je vlevo.
ARRIVE_RIGHT	string	Přišli jste. Tvůj cíl je na pravé straně.
BEAR_LEFT	string	Medvěd doleva.
BEAR_RIGHT	string	Mějte pravdu.
DEPART	string	Odjet.
ENTER_FREEWAY	string	Jeďte po dálnici.
ENTER_HIGHWAY	string	Jeďte po dálnici.
ENTER_MOTORWAY	string	Jeďte po dálnici.
ENTRANCE_RAMP	string	Vezmi rampu.
FOLLOW	string	Následovat.
KEEP_LEFT	string	Drž se doleva.
KEEP_RIGHT	string	Mějte pravdu.
MAKE_UTURN	string	Otočte se do U.
MOTORWAY_EXIT_LEFT	string	Jděte levým východem.
MOTORWAY_EXIT_RIGHT	string	Vyjděte správným východem.
ROUNDABOUT_BACK	string	Běžte kolem kruhového objezdu.
ROUNDABOUT_CROSS	string	Přechánět kruhový objezd.
ROUNDABOUT_LEFT	string	Na kruhovém objezdu vyjděte vlevo.
ROUNDABOUT_RIGHT	string	Na kruhovém objezdu vyjděte vpravo.
SHARP_LEFT	string	Otočte se doleva.
SHARP_RIGHT	string	Otočte se ostře doprava.
STRAIGHT	string	Držte se rovně.
SWITCH_MAIN_ROAD	string	Přepne se na hlavní silnici.
SWITCH_PARALLEL_ROAD	string	Přepněte na paralelní silnici.
TAKE_EXIT	string	Jděte na východ.
TAKE_FERRY	string	Jeďte trajektem.
TRY_MAKE_UTURN	string	Zkuste otočit oušku.
TURN_LEFT	string	Zatočit doleva.
TURN_RIGHT	string	Zatočit doprava.
WAYPOINT_LEFT	string	Dosáhli jste bodu cesty. Je nalevo.
WAYPOINT_REACHED	string	Dosáhli jste bodu cesty.
WAYPOINT_RIGHT	string	Dosáhli jste bodu cesty. Je na pravé straně.

JsonFormat

Požadovaný formát odpovědi. Podporuje se pouze json formát.

Name	Typ	Description
json	string	Formát výměny dat v zápisu objektů JavaScriptu

JunctionType

Typ spojení, kde se manévr provádí. Pro větší kruhové objezdy jsou generovány dva samostatné pokyny pro vstup a odchod z kruhového objezdu.

Name	Typ	Description
BIFURCATION	string	bifurkace
REGULAR	string	pravidelný
ROUNDABOUT	string	kruhový objezd

LatLongPair

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

Name	Typ	Description
latitude	number	Vlastnost Zeměpisná šířka
longitude	number	Zeměpisná délka – vlastnost

Response

Výsledek dotazu. RouteDirections, pokud se dotaz úspěšně dokončil, ErrorResponse v opačném případě.

Name	Typ	Description
error	ErrorDetail	Objekt chyby.
formatVersion	string	Formátovat vlastnost Verze
optimizedWaypoints	RouteOptimizedWaypoint[]	Optimalizovaná posloupnost waypointů. Zobrazí index ze sekvence waypointu poskytnutého uživatelem 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 [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	Hlásí platná nastavení použitá v aktuálním volání.
routes	Route[]	Pole routes

ResponseSectionType

Typy oddílů hlášené trasy

Name	Typ	Description
CARPOOL	string	Úseky trasy, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle.
CAR_TRAIN	string	Úseky trasy, které jsou osobními nebo vlaky.
COUNTRY	string	Oddíly označující země nebo oblasti, ve kterých se trasa nachází.
FERRY	string	Úseky trasy, které jsou trajekty.
MOTORWAY	string	Úseky trasy, které jsou dálnicemi.
PEDESTRIAN	string	Úseky trasy, které jsou vhodné pouze pro pěší.
TOLL_ROAD	string	Úseky trasy, které vyžadují placenou platbu.
TOLL_VIGNETTE	string	Úseky trasy, které vyžadují dálniční známku.
TRAFFIC	string	Oddíly trasy, které obsahují informace o provozu.
TRAVEL_MODE	string	Oddíly ve vztahu k parametru travelModepožadavku .
TUNNEL	string	Části trasy, které jsou tunely.
URBAN	string	Úseky trasy, které se nacházejí v městských oblastech.

ResponseTravelMode

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

Name	Typ	Description
bicycle	string	Vrácené trasy jsou optimalizované pro jízdní kola, včetně použití cyklostezek.
bus	string	Vrácené trasy jsou optimalizované pro autobusy, včetně použití pouze autobusových jízdních pruhů. Funkce BETA.
car	string	Vrácené trasy jsou optimalizované pro auta.
motorcycle	string	Vrácené trasy jsou optimalizované pro motocykly. Funkce BETA.
other	string	Daný způsob dopravy není v této části možný.
pedestrian	string	Vrácené trasy jsou optimalizované pro chodce, včetně použití chodníků.
taxi	string	Vrácené trasy jsou optimalizované pro taxislužby. Funkce BETA.
truck	string	Vrácené trasy jsou optimalizované pro užitková vozidla, například pro nákladní vozy.
van	string	Vrácené trasy jsou optimalizované pro dodávky. Funkce BETA.

Route

Name	Typ	Description
guidance	RouteGuidance	Obsahuje prvky související s pokyny. Toto pole je k dispozici pouze v případě, že bylo požadováno doprovodné materiály a je k dispozici.
legs	RouteLeg[]	Pole nohy
sections	RouteSection[]	Pole Oddílů
summary	RouteSummary	Souhrnný objekt

RouteDirectionsBatchItem

Položka vrácená z volání služby Batch route Directions.

Name	Typ	Description
response	Response	Výsledek dotazu. RouteDirections, pokud se dotaz úspěšně dokončil, ErrorResponse v opačném případě.
statusCode	integer	Stavový kód požadavku HTTP.

RouteDirectionsBatchResult

Tento objekt se vrátí z úspěšného volání služby Batch směr trasy.

Name	Typ	Description
batchItems	RouteDirectionsBatchItem[]	Pole obsahující výsledky dávky.
summary	Summary	Souhrn výsledků dávkové žádosti

RouteGuidance

Obsahuje prvky související s pokyny. Toto pole je k dispozici pouze v případě, že bylo požadováno doprovodné materiály a je k dispozici.

Name	Typ	Description
instructionGroups	RouteInstructionGroup[]	Seskupí posloupnost instrukčních prvků, které spolu vzájemně souvisejí.
instructions	RouteInstruction[]	Seznam pokynů popisujících manévry.

RouteInstruction

Sada atributů popisujících manévr, např. "Zatáčkejte doprava", "Keep left", "Take the ferry", "Take the motorway", "Take the motorway", 'Arrive'.

Name	Typ	Description
combinedMessage	string	Člověkem čitelná zpráva o manévru v kombinaci se zprávou z další instrukce. Někdy je možné zkombinovat dvě po sobě jdoucí instrukce do jedné a usnadnit tak jejich sledování. V takovém případě bude příznak possibleCombineWithNext mít hodnotu true. Příklad: 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam Příznak possibleCombineWithNext v instrukci 10 má hodnotu true. To indikuje klientům programových pokynů, že je možné je kombinovat s instrukcemi 11. Pokyny se automaticky zkombinují pro klienty, kteří požadují pokyny čitelné pro člověka. Pole combinedMessage obsahuje kombinovanou zprávu: Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode	string	3znakový kód země ISO 3166-1 alfa-3. Např. USA.
drivingSide	DrivingSide	Označuje jízdu vlevo a vpravo v místě manévru.
exitNumber	string	Čísla exitu z dálnice pořízená aktuálním manévrem. Pokud má exit více výstupních čísel, bude oddělen "," a pravděpodobně agregován podle "-", například "10, 13-15".
instructionType	GuidanceInstructionType	Typ instrukce, např. zatáčení nebo změna jízdního tvaru.
junctionType	JunctionType	Typ křižovatky, kde se provádí manévr. Pro větší kruhové objezdy 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á zpráva pro manévr.
point	LatLongPair	Umístění reprezentované jako zeměpisná šířka a délka.
pointIndex	integer	Index bodu v seznamu "bodů" křivky odpovídající bodu instrukce.
possibleCombineWithNext	boolean	Volitelně je možné zkombinovat instrukce s další. Můžete ho použít k vytváření zpráv jako "Turn left and then turn right" (Otočit se doleva a pak doprava).
roadNumbers	string[]	Čísla silnic dalších významných segmentů silnic po manévru nebo silnic, které se mají sledovat. Příklad: ["E34", "N205"]
roundaboutExitNumber	integer	To označuje, který východ se má provést na kruhovém objezdu.
routeOffsetInMeters	integer	Vzdálenost od začátku trasy k bodu instrukce.
signpostText	string	Text na rozcestníku, který je nejrelevantní pro manévr nebo směr, který se má sledovat.
stateCode	string	Dílčí dělení (např. stát) země, reprezentované druhou částí kódu ISO 3166-2 . 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 ulice, která by měla následovat.
travelTimeInSeconds	integer	Odhadovaná doba cesty až do bodu odpovídajícího routeOffsetInMeters.
turnAngleInDecimalDegrees	integer	Označuje směr instrukce. Pokud junctionType indikuje instrukci otočení: 180 = otočení U [-179, -1] = otočení doleva 0 = rovnou (otočení o 0 stupňů) [1, 179] = otočení doprava Pokud junctionType indikuje instrukce bifurcation: <0 – ponechat doleva >0 – držte se prava

RouteInstructionGroup

Seskupí posloupnost instrukčních prvků, které spolu vzájemně souvisejí. Rozsah sekvence je omezen s firstInstructionIndex a lastInstructionIndex. Pokud jsou pro pokyny požadovány textové zprávy čitelné pro člověka (instructionType=text nebo tagged), vrátí se do skupiny instructionGroup souhrnná zpráva, 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, když jsou pro pokyny požadovány textové zprávy čitelné pro člověka (instructionType=text nebo tagged).
lastInstructionIndex	integer	Index poslední instrukce v pokynech a patřící do této skupiny.

RouteLeg

Popis části trasy, která se skládá ze seznamu bodů. Každý další směrový bod zadaný v požadavku bude mít za následek další úsek ve vrácené trase.

Name	Typ	Description
points	LatLongPair[]	Pole bodů
summary	RouteLegSummary	Souhrnný objekt pro oddíl trasy.

RouteLegSummary

Souhrnný objekt pro oddíl trasy.

Name	Typ	Description
arrivalTime	string	Odhadovaný čas příjezdu na trasu nebo úsek. Čas je v UTC.
batteryConsumptionInkWh	number	Odhadovaná spotřeba elektrické energie v kilowatthodinách (kWh) s využitím modelu elektrické spotřeby. Zahrnuto, pokud je vehicleEngineType nastaven na elektrický a je zadána konstantaSpeedConsumptionInkWhPerHundredkm. Hodnota batteryConsumptionInkWh zahrnuje rekuperated elektrickou energii, a proto může být záporná (což značí získává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, ve výpočtu spotřeby se předpokládá netrénovaná rekuperace.
departureTime	string	Odhadovaný čas odjezdu trasy nebo úseku. Čas je v UTC.
fuelConsumptionInLiters	number	Odhadovaná spotřeba paliva v litrech s využitím modelu spotřeby spalování. Zahrnuje, pokud je vlastnost vehicleEngineType nastavená na spalování a je zadána hodnota constantSpeedConsumptionInLitersPerHundredkm. Hodnota nebude záporná.
historicTrafficTravelTimeInSeconds	integer	Odhadovaná doba jízdy vypočítaná pomocí historických dat o provozu závislých na čase. Zahrnuté pouze v případě, že se v dotazu použije computeTravelTimeFor = all.
lengthInMeters	integer	Vlastnost Length In Meters
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žije computeTravelTimeFor = all.
noTrafficTravelTimeInSeconds	integer	Odhadovaná doba jízdy vypočítaná tak, že na trase nedochází ke zpoždění kvůli dopravní situaci (např. přetížení). Zahrnuté pouze v případě, že se v dotazu použije computeTravelTimeFor = all.
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 odjezdu v budoucnu je 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	Vlastnost Odhadovaná doba jízdy v sekundách, která zahrnuje zpoždění způsobené provozem v reálném čase. Všimněte si, že i když traffic=false travelTimeInSeconds stále zahrnuje zpoždění způsobené provozem. Pokud je DepartAt v budoucnosti, doba trvání cesty se vypočítá pomocí historických dat o provozu závislých na čase.

RouteOptimizedWaypoint

Optimalizovaný objekt bodu cesty.

Name	Typ	Description
optimizedIndex	integer	Optimalizovaný index bodu cesty ze systému.
providedIndex	integer	Index bodu cesty poskytnutý uživatelem.

RouteReport

Hlásí platná nastavení použitá v aktuálním volání.

Name	Typ	Description
effectiveSettings	EffectiveSetting[]	Efektivní parametry nebo data použitá při volání tohoto rozhraní API směrování

RouteSection

Oddíly tras obsahují další informace o částech trasy. Každý oddíl obsahuje alespoň elementy 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, zprůměrovaná přes celou jeho délku.
endPointIndex	integer	Index posledního bodu (posun 0) v trase, na které se tento oddíl vztahuje.
magnitudeOfDelay	DelayMagnitude	Velikost zpoždění způsobeného incidentem. Tyto hodnoty odpovídají hodnotám pole odpovědi ty rozhraní API Get Traffic Incident Detail.
sectionType	ResponseSectionType	Typy oddílů hlášené trasy
simpleCategory	SimpleCategory	Typ incidentu. V současné době může být JAM, ROAD_WORK, ROAD_CLOSURE nebo JINÉ. Podrobné informace najdete v části "tec".
startPointIndex	integer	Index prvního bodu (posun 0) na trase, na které se tento oddíl vztahuje.
tec	RouteSectionTec	Podrobnosti o události provozu pomocí definic ve standardu TPEG2-TEC Může obsahovat elementy effectCode a způsobuje.
travelMode	ResponseTravelMode	Cestovní režim pro počítanou trasu. Hodnota se nastaví na other , pokud požadovaný způsob dopravy není v této části možný.

RouteSectionTec

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

Name	Typ	Description
causes	RouteSectionTecCause[]	Způsobuje pole
effectCode	integer	Vliv na tok provozu. Obsahuje hodnotu v tabulce tec001:EffectCode, jak je definována ve standardu TPEG2-TEC . Lze použít k barevnému kódování událostí provozu podle závažnosti.

RouteSectionTecCause

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říčina dopravní události. Obsahuje hodnotu v tabulce tec002:CauseCode, jak je definována ve standardu TPEG2-TEC .
subCauseCode	integer	Subcause události provozu. Obsahuje hodnotu v tabulce dílčí příčiny definovanou parametrem mainCauseCode, jak je definováno ve standardu TPEG2-TEC .

RouteSummary

Souhrnný objekt

Name	Typ	Description
arrivalTime	string	Odhadovaný čas příjezdu na trasu nebo úsek. Čas je v UTC.
departureTime	string	Odhadovaný čas odjezdu trasy nebo úseku. Čas je v UTC.
lengthInMeters	integer	Vlastnost Length In Meters
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 odjezdu v budoucnu je 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	Vlastnost Odhadovaná doba jízdy v sekundách, která zahrnuje zpoždění způsobené provozem v reálném čase. Všimněte si, že i když traffic=false travelTimeInSeconds stále zahrnuje zpoždění způsobené provozem. Pokud je DepartAt v budoucnosti, doba trvání cesty se vypočítá pomocí historických dat o provozu závislých na čase.

SimpleCategory

Typ incidentu. V současné době může být JAM, ROAD_WORK, ROAD_CLOSURE nebo JINÉ. Podrobné informace najdete v části "tec".

Name	Typ	Description
JAM	string	Dopravní zácpa.
OTHER	string	Jiné
ROAD_CLOSURE	string	Uzavírka silnice.
ROAD_WORK	string	Práce na silnici.

Summary

Souhrn výsledků dávkové žádosti

Name	Typ	Description
successfulRequests	integer	Počet úspěšných požadavků v dávce
totalRequests	integer	Celkový počet požadavků v dávce