Route - Post Route Directions Batch

Reference

Služba:: Maps

Verze rozhraní API:: 1.0

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

Rozhraní API Post Route Directions Batch je požadavek HTTP POST, který odesílá dávky dotazů do Získání směrů tras api pomocí jednoho asynchronního požadavku. Můžete volat rozhraní API Route Directions Batch tak, aby se spustilo asynchronně (async), nebo synchronně (synchronně). Asynchronní rozhraní API umožňuje volajícímu dávkovat až 700 dotazů a synchronizovat rozhraní API až do 100 dotazů. Pokud chcete volat rozhraní API Post Route Directions Batch v synchronním požadavku, přečtěte si téma Směry směrování služby Batch Sync.

Odeslání asynchronního dávkového požadavku

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků na trasu.

Umožňuje načtení výsledků v samostatném volání (je možné stáhnout více souborů).
Asynchronní rozhraní API je optimalizované pro spolehlivost a neočekává se, že dojde k vypršení časového limitu.
Počet dávkových položek je omezený na 700 pro toto rozhraní API.

Když provedete požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL přesměrování v poli Umístění hlavičky odpovědi. Tato adresa URL by se měla pravidelně kontrolovat, dokud nebudou k dispozici data odpovědí nebo informace o chybě. Asynchronní odpovědi se ukládají po dobu 24 hodin. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po uplynutí doby platnosti.

Upozorňujeme, že asynchronní dávkový požadavek je dlouhotrvající operace. Tady je typická posloupnost operací:

Klient odešle do služby Azure Maps žádost o směrování služby Batch POST.

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

Server odpoví jedním z následujících způsobů:

202 Accepted HTTP – Žádost batch byla přijata.

HTTP Error – Při zpracování požadavku batch došlo k chybě. Může to být 400 Bad Request nebo jakýkoli jiný stavový kód Error.
Pokud se dávkový požadavek úspěšně přijal, hlavička Location v odpovědi obsahuje adresu URL pro stažení výsledků dávkové žádosti. Tento identifikátor URI stavu vypadá takto:

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

Klient vydá GET požadavek na adresu URL pro stažení získané v kroku 3 ke stažení výsledků dávky.

Text POST pro dávkový požadavek

Pokud chcete odeslat směr trasy dotazy, použijete požadavek POST, kde text požadavku bude obsahovat pole batchItems ve formátu json a hlavička Content-Type bude nastavená na application/json. Tady je ukázkový text požadavku obsahující 3 směry trasy dotazy:

{
    "batchItems": [
        { "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" },
        { "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
    ]
}

Směr trasy dotazu v dávce je pouze částečná adresa URL bez protokolu, základní adresy URL, cesty, verze api a klíče předplatného. Může přijmout kterýkoli z podporovaných směrů trasyparametry identifikátoru URI. Řetězcové hodnoty v směrech trasy dotazu musí být správně uchycené (např. znak " by měl být uchvácen pomocí \ ) a měl by být také správně zakódován adresou URL.

Asynchronní rozhraní API umožňuje volajícímu dávkovat až 700 dotazů a synchronizovat rozhraní API až do 100 dotazů a dávka by měla obsahovat alespoň 1 dotaz.

Stažení asynchronních dávkových výsledků

Pokud chcete stáhnout asynchronní výsledky dávky, vydáte GET požadavek na koncový bod dávkového stahování. Tuto adresu URL pro stažení lze získat z hlavičky úspěšného dávkového požadavku a vypadá takto:

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

Tady je typická posloupnost operací pro stahování výsledků dávky:

Klient odešle požadavek GET pomocí adresy URL pro stažení .
Server odpoví jedním z následujících způsobů:

202 Accepted HTTP – Požadavek batch byl přijat, ale stále se zpracovává. Zkuste to prosím znovu za nějakou dobu.

HTTP 200 OK – Dávkové požadavky byly úspěšně zpracovány. Tělo odpovědi obsahuje všechny dávkové výsledky.

Model dávkové odpovědi

Vrácený datový obsah je podobný asynchronním a synchronizačním požadavkům. Při stahování výsledků asynchronní dávkové žádosti, pokud dávka dokončila zpracování, text odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje komponentu summary, která označuje totalRequests, které byly součástí původní dávkové žádosti a successfulRequeststj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje také pole batchItems, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. batchItems bude obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkové žádosti. Každá položka v batchItems obsahuje pole statusCode a response. Každý response v batchItems má jeden z následujících typů:

RouteDirections – Pokud se dotaz úspěšně dokončil.
Error – Pokud dotaz selhal. Odpověď bude obsahovat code a v tomto případě message.

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

{
    "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/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 pro účet Azure Maps a dá se načíst z rozhraní API účtu roviny správy Azure Maps. Informace o používání zabezpečení Microsoft Entra ID v Azure Maps najdete v následujících článcích s pokyny.

Text požadavku

Name	Typ	Description
batchItems	BatchRequestItem[]	Seznam dotazů, které se mají zpracovat.

Odpovědi

Name	Typ	Description
200 OK	RouteDirectionsBatchResult	Dávkový požadavek se úspěšně zpracoval. Tělo odpovědi obsahuje všechny dávkové výsledky.
202 Accepted		Podporuje se pouze pro asynchronní požadavek. Žádost přijata: Žádost byla přijata ke zpracování. K opakování nebo přístupu k výsledkům použijte adresu URL v hlavičce umístění. Hlavičky Location: string
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Name

Typ

Description

200 OK

RouteDirectionsBatchResult

Dávkový požadavek se úspěšně zpracoval. Tělo odpovědi obsahuje všechny dávkové výsledky.

202 Accepted

Podporuje se pouze pro asynchronní požadavek. Žádost přijata: Žádost byla přijata ke zpracování. K opakování nebo přístupu k výsledkům použijte adresu URL v hlavičce umístění.

Hlavičky

Location: string

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í.

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 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 submit a route direction batch request

Ukázkový požadavek

HTTP

POST https://atlas.microsoft.com/route/directions/batch/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:: 202

operation-Location: URL to download the results of the long-running batch request.

Definice

Name	Description
BatchRequest	Tento typ představuje text požadavku pro službu Batch.
BatchRequestItem	Objekt žádosti Batch
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.
JsonFormat	Požadovaný formát odpovědi Podporuje se pouze `json` formát.
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
Response	Výsledek dotazu. RouteDirections pokud dotaz úspěšně dokončil, ErrorResponse jinak.
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
RouteDirectionsBatchItem	Položka vrácená voláním služby Route Directions Batch.
RouteDirectionsBatchResult	Tento objekt se vrátí z úspěšného volání služby Route Directions Batch.
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.
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í.
RouteSection	Oddíly trasy obsahují další informace o částech trasy. Každý oddíl obsahuje alespoň prvky `startPointIndex`, `endPointIndex`a `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
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".
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ů, které se mají zpracovat.

BatchRequestItem

Objekt žádosti Batch

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

DelayMagnitude

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

Name	Typ	Description
0	string	Neznámý.
1	string	Moll.
2	string	Moderovat.
3	string	Major.
4	string	Nedefinováno, používáno pro uzavření silnic a další neomezená zpoždění.

DrivingSide

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

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

EffectiveSetting

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

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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GuidanceInstructionType

Typ instrukce, např. otáčení nebo změna silniční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řijel jsi.
ARRIVE_LEFT	string	Přijel jsi. Cíl je na levé straně.
ARRIVE_RIGHT	string	Přijel jsi. Váš cíl je na pravé straně.
BEAR_LEFT	string	Medvěd zbyl.
BEAR_RIGHT	string	Noste právo.
DEPART	string	Odjet.
ENTER_FREEWAY	string	Vezmi si volný chodník.
ENTER_HIGHWAY	string	Vezmi si dálnici.
ENTER_MOTORWAY	string	Vezmi si dálnici.
ENTRANCE_RAMP	string	Vezmi rampu.
FOLLOW	string	Následovat.
KEEP_LEFT	string	Držte se doleva.
KEEP_RIGHT	string	Držte se správně.
MAKE_UTURN	string	Nastavte U-turn.
MOTORWAY_EXIT_LEFT	string	Jděte doleva.
MOTORWAY_EXIT_RIGHT	string	Vezmi pravý konec.
ROUNDABOUT_BACK	string	Běž kolem kruhového objezdu.
ROUNDABOUT_CROSS	string	Přes kruhový objezd.
ROUNDABOUT_LEFT	string	V kruhovém kruhovém objezdu vyjíždět nalevo.
ROUNDABOUT_RIGHT	string	V kruhovém kruhovém objezdu vystupte na pravé straně.
SHARP_LEFT	string	Otočte se doleva.
SHARP_RIGHT	string	Otápět doprava.
STRAIGHT	string	Držte se rovnou.
SWITCH_MAIN_ROAD	string	Přejděte na hlavní silnici.
SWITCH_PARALLEL_ROAD	string	Přepněte na paralelní cestu.
TAKE_EXIT	string	Vezmi si východ.
TAKE_FERRY	string	Vezmi trajekt.
TRY_MAKE_UTURN	string	Zkuste udělat U-turn.
TURN_LEFT	string	Zatočit doleva.
TURN_RIGHT	string	Zatočit doprava.
WAYPOINT_LEFT	string	Dosáhli jste směrového bodu. Je na levé straně.
WAYPOINT_REACHED	string	Dosáhli jste směrového bodu.
WAYPOINT_RIGHT	string	Dosáhli jste směrového bodu. 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 javascriptového objektu

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.

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

LatLongPair

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

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

Response

Výsledek dotazu. RouteDirections pokud dotaz úspěšně dokončil, ErrorResponse jinak.

Name	Typ	Description
error	ErrorDetail	Objekt chyby.
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

ResponseSectionType

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

Name	Typ	Description
CARPOOL	string	Úseky trasy, které vyžadují použití jízdních pruhů HOV/High Occupancy Vehicle( HOV/ High Occupancy Vehicle).
CAR_TRAIN	string	Oddíly trasy, které jsou auty nebo vlaky.
COUNTRY	string	Oddíly označující, ve kterých zemích nebo oblastech trasa je.
FERRY	string	Úseky trasy, které jsou trajekty.
MOTORWAY	string	Úseky trasy, které jsou dálnicemi.
PEDESTRIAN	string	Úseky trasy, které jsou vhodné pouze pro chodce.
TOLL_ROAD	string	Oddíly trasy, které vyžadují placení placené linky.
TOLL_VIGNETTE	string	Oddíly trasy, které vyžadují, aby byla přítomna bezplatná dálniční známka.
TRAFFIC	string	Oddíly trasy, které obsahují informace o provozu
TRAVEL_MODE	string	Oddíly týkající se parametru požadavku `travelMode`.
TUNNEL	string	Oddíly trasy, které jsou tunely.
URBAN	string	Úseky trasy, které se nacházejí v městských oblastech.

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ý.

Name	Typ	Description
bicycle	string	Vrácené trasy jsou optimalizované pro jízdní kola, včetně použití jízdních pruhů.
bus	string	Vrácené trasy jsou optimalizované pro autobusy, včetně použití pouze 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 komerční vozidla, jako jsou nákladní vozy.
van	string	Vrácené trasy jsou optimalizované pro dodávky. Funkce BETA.

Route

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

RouteDirectionsBatchItem

Položka vrácená voláním služby Route Directions Batch.

Name	Typ	Description
response	Response	Výsledek dotazu. RouteDirections pokud dotaz úspěšně dokončil, ErrorResponse jinak.
statusCode	integer	Stavový kód požadavku HTTP.

RouteDirectionsBatchResult

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

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

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.

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

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	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 = U-turn [-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

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

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.

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á doba příjezdu pro trasu nebo nohu. Čas je ve standardu UTC.
batteryConsumptionInkWh	number	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	Odhadovaná doba odletu pro trasu nebo nohu. Čas je ve standardu UTC.
fuelConsumptionInLiters	number	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

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

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

RouteSection

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

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

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

Souhrnný objekt

Name	Typ	Description
arrivalTime	string	Odhadovaná doba příjezdu pro trasu nebo nohu. Čas je ve standardu UTC.
departureTime	string	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.

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".

Name	Typ	Description
JAM	string	Dopravní zácpa.
OTHER	string	Jiný.
ROAD_CLOSURE	string	Uzavírací cesta.
ROAD_WORK	string	Silniční práce.

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

Sdílet prostřednictvím

Route - Post Route Directions Batch

Odeslání asynchronního dávkového požadavku

Text POST pro dávkový požadavek

Stažení asynchronních dávkových výsledků

Model dávkové odpovědi

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

AADToken

Poznámky

Rozsahy

subscription-key

SAS Token

Příklady

Successfully submit a route direction batch request

Ukázkový požadavek

Ukázková odpověď

Definice

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

Další materiály