Route

  • Reference
Service:
Maps
API Version:
1.0

Operations

Get Route Directions

Platí pro: cenové úrovně S0 a S1.

Vrátí trasu mezi počátkem a cílem a procházející přes waypoints, pokud jsou zadány. Trasa bude brát v úvahu faktory, jako je aktuální provoz a obvyklá rychlost provozu pro požadovaný den v týdnu a denní dobu.

Vrácené informace zahrnují vzdálenost, odhadovanou dobu trvání cesty a reprezentace geometrie trasy. V závislosti na vybraných možnostech jsou k dispozici také další informace o směrování, jako je například optimalizované pořadí bod na trase nebo zapnout funkci zapnout.

Směrovací služba poskytuje sadu parametrů pro podrobný popis modelu spotřeby specifického pro vozidlo. Podrobnější vysvětlení konceptů a parametrů, které se týkají, najdete v modelu spotřeby .
Get Route Range

Rozhraní API rozsahu trasy (Isochrone)

Platí pro: cenová úroveň S1.

Tato služba vypočítá sadu umístění, která se dají kontaktovat ze zdrojového bodu na základě zadaného paliva, energie, času nebo rozpočtu ujeté vzdálenosti. Na hranici mnohoúhelníku (neboli Isochrone) se vrátí orientace proti směru hodinových ručiček a také přesné mnohoúhelníkové centrum, které bylo výsledkem počátečního bodu.

Vrácený mnohoúhelník lze použít pro další zpracování, jako je například vyhledávání v geometrii hledání zájmu v rámci poskytnutého Isochrone.
Post Route Directions

Platí pro: cenové úrovně S0 a S1.

Vrátí trasu mezi počátkem a cílem a procházející přes waypoints, pokud jsou zadány. Trasa bude brát v úvahu faktory, jako je aktuální provoz a obvyklá rychlost provozu pro požadovaný den v týdnu a denní dobu.

Vrácené informace zahrnují vzdálenost, odhadovanou dobu trvání cesty a reprezentace geometrie trasy. V závislosti na vybraných možnostech jsou k dispozici také další informace o směrování, jako je například optimalizované pořadí bod na trase nebo zapnout funkci zapnout.

Směrovací služba poskytuje sadu parametrů pro podrobný popis modelu spotřeby specifického pro vozidlo. Podrobnější vysvětlení konceptů a parametrů, které se týkají, najdete v modelu spotřeby .
Post Route Directions Batch

Rozhraní API pro dávkové směrování tras

Platí pro: cenová úroveň S1.

Rozhraní API pro směrování tras do dávky odesílá dávky dotazů do rozhraní API pro směrování instrukcí pomocí jediného volání rozhraní API. Můžete zavolat rozhraní API pro směrování v trasách, které se spustí asynchronně (Async) nebo synchronně (Sync). Asynchronní rozhraní API umožňuje volajícímu dávkování až 700 dotazů a synchronizaci rozhraní API až do 100 dotazů.

Odeslat synchronní požadavek dávky

Pro odlehčené požadavky Batch se doporučuje synchronní rozhraní API. Když služba obdrží požadavek, odpoví hned po výpočtu položek dávky a nebude možné výsledky načíst později. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet položek dávky 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}

Odeslat asynchronní požadavek dávky

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

  • Umožňuje načtení výsledků v samostatném volání (více souborů ke stažení je možné).
  • Asynchronní rozhraní API je optimalizováno pro spolehlivost a neočekává se, že bude spuštěno v časovém limitu.
  • Počet položek dávky je pro toto rozhraní API omezený na 700 .

Když vytvoříte 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 pro přesměrování v poli umístění v hlavičce odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Asynchronní odpovědi jsou uloženy po dobu 14 dnů. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po období vypršení platnosti.

Všimněte si, že asynchronní požadavek Batch je dlouhotrvající požadavek. Tady je typická posloupnost operací:

  1. Klient pošle POST požadavek na směrování tras do Azure Maps

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat.

    HTTP Error – při zpracování žádosti dávky došlo k chybě. Může to být buď 400 Bad Request nebo jakýkoli jiný Error stavový kód.

  3. Pokud byl požadavek dávky úspěšně přijat, Location Hlavička v odpovědi obsahuje adresu URL pro stažení výsledků žádosti o dávku. Tento identifikátor URI stavu vypadá takto:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 Poznámka: – Nezapomeňte před spuštěním přidat informace o ověřování (předplatná-Key/azure_auth-See Security) do identifikátoru URI stavu .
4. Klient vydá GET požadavek na adresu URL pro stažení získanou v kroku 3 ke stažení výsledků dávky.

Tělo příspěvku pro požadavek Batch

Chcete-li odeslat dotazy na trasy směrování , budete používat POST žádost, kde text žádosti bude obsahovat batchItems pole ve json formátu a Content-Type záhlaví bude nastaveno na application/json . Tady je ukázkový text požadavku, který obsahuje tři dotazy na trasy tras :

{
    "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" }
    ]
}

Dotaz na itinerář trasy v dávce je jenom částečná adresa URL bez protokolu, základní adresy URL, cesty, verze rozhraní API a klíč předplatného. Může přijmout jakýkoli z podporovaných parametrů identifikátoru URI tras . Řetězcové hodnoty v dotazu itineráře trasy musí být správně uvozeny (např. "znak by měl být uvozen" \ ) a musí být také správně KÓDOVÁNY pomocí adresy URL.

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

Stáhnout asynchronní výsledky dávky

Pro stažení výsledků asynchronní dávky budete vydávat GET požadavek na koncový bod stažení služby Batch. Tuto adresu URL pro stažení lze získat z Location hlavičky úspěšného POST požadavku dávky a vypadá takto:

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

Toto je typická posloupnost operací pro stažení výsledků dávky:

  1. Klient odešle GET požadavek pomocí adresy URL pro stažení.

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat, ale stále probíhá jeho zpracování. Zkuste to prosím znovu za chvíli.

    200 OKPožadavek HTTP-Batch byl úspěšně zpracován. Tělo odpovědi obsahuje všechny výsledky dávky.

Model dávkové odezvy

Vrácený obsah dat je podobný jako u požadavků na asynchronní a synchronní synchronizaci. Při stahování výsledků asynchronního požadavku dávky, pokud dávka dokončila zpracování, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje summary komponentu, která indikuje, totalRequests které byly součástí původní žádosti dávky, a to znamená, že successfulRequests dotazy byly úspěšně provedeny. Tato odpověď zahrnuje také batchItems pole, které obsahuje odpověď pro každý dotaz v dávkové žádosti a všechny dotazy. batchItemsBude obsahovat výsledky v přesném pořadí, v jakém byly původní dotazy odeslány v dávce požadavku. Každá položka v batchItems statusCode poli obsahuje a response . Každý response z batchItems těchto typů je jeden z následujících typů:

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

  • Error – Pokud se dotaz nezdařil. codeV tomto případě bude odpověď obsahovat a a message .

Tady je ukázková odpověď dávky 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 Route Matrix

Platí pro: cenová úroveň S1.

Služba směrování matice umožňuje výpočet matice souhrnů tras pro sadu tras definovaných podle původu a cílových umístění pomocí asynchronního (asynchronního) nebo synchronního (synchronizačního) požadavku POST. U každého původu služba vypočítá náklady na směrování z tohoto zdroje na každý daný cíl. Množina počátek a sada cílů se dá představit jako záhlaví sloupců a řádků v tabulce a každá buňka v tabulce obsahuje náklady na směrování od počátku do cíle pro tuto buňku. Řekněme například, že společnost pro doručování potravin má 20 ovladačů a potřebuje najít nejbližší ovladač pro výběr dodávky z restaurace. Pro vyřešení tohoto případu použití mohou volat rozhraní API pro rozhraní matice.

Pro každou trasu se vrátí doby trvání cesty a vzdálenosti. Vypočtené náklady můžete použít k určení, které podrobné trasy se mají vypočítat pomocí rozhraní API pro trasy tras.

Maximální velikost matice pro asynchronní požadavek je 700 a pro požadavek na synchronizaci je to 100 (počet původních vynásobený počtem cílů).

Odeslat požadavek na matici synchronní trasy

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, může být vhodné provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původních vynásobený počtem cílů). S tímto omezením jsou příklady možných dimenzí matice: 10x10, 6x8, 9x8 (nemusí být čtvercový).

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

Odeslat požadavek na matici asynchronních tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů poměrně složitých žádostí o směrování. Když vytvoříte 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 pro přesměrování v poli umístění v hlavičce odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Pokud waitForResults je parametr v požadavku nastavený na hodnotu true, obdrží uživatel odpověď 200, pokud je žádost dokončená pod 120 sekund.

Maximální velikost matice pro toto rozhraní API je 700 (počet původních vynásobený počtem cílů). S tímto omezením je třeba mít příklady možných dimenzí matice: 50x10, 10x10, 28x25. 10x70 (nemusí být čtvercové).

Asynchronní odpovědi se ukládají po dobu 14 dnů. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po uplynutí doby vypršení platnosti.

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

Tady je typická posloupnost asynchronních operací:

  1. Klient odešle požadavek POST matice směrování do Azure Mapy

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

    HTTP 202 Accepted – Požadavek na směrovací matici byl přijat.

    HTTP – Při zpracování požadavku matice tras Error došlo k chybě. Může to být buď chybný požadavek 400, nebo jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu přijat úspěšně, hlavička Location v odpovědi obsahuje adresu URL pro stažení výsledků požadavku. Tento identifikátor URI stavu vypadá takto:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient vydá požadavek GET na adresu URL pro stažení, kterou jste získali v kroku 3, a stáhne výsledky.

Stažení výsledků synchronizace

Když pro rozhraní API pro synchronizaci matice tras vyžádáte požadavek POST, služba vrátí kód odpovědi 200 pro úspěšný požadavek a pole odpovědí. Tělo odpovědi bude obsahovat data a později nebude možné výsledky načíst.

Stažení výsledků s modifikátorem Async

Když žádost vydá odpověď, požadavek se zpracovává 202 Accepted pomocí našeho asynchronního kanálu. V hlavičce location odpovědi se zobrazí adresa URL pro kontrolu průběhu asynchronního požadavku. Tento identifikátor URI stavu vypadá takto:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

Adresa URL poskytnutá hlavičkou location vrátí při vydání požadavku GET následující odpovědi.

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

HTTP 200 OK – Požadavek matice se úspěšně zpracuje. Text odpovědi obsahuje všechny výsledky.