Sdílet prostřednictvím

@azure-rest/maps-route package

  • Reference

Rozhraní

BatchRequest

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

Objekt žádosti Batch
BatchResultItemOutput

Položka vrácená z rozhraní API služby Batch. Rozšíření s vlastností response
BatchResultOutput

Tento objekt se vrátí z úspěšného volání služby Batch. Extend with 'batchItems' vlastnost.
BatchResultSummaryOutput

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

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

Podrobnosti o chybě.
ErrorResponseOutput

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
GeoJsonFeature

Platný typ objektu GeoJSON Feature. Podrobnosti najdete v RFC 7946.
GeoJsonFeatureCollection

Platný typ objektu GeoJSON FeatureCollection. Podrobnosti najdete v RFC 7946.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Platný typ objektu GeoJSON GeometryCollection. Podrobnosti najdete v RFC 7946.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Platný objekt geometrie GeoJSON. Typ musí být jedním z sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v RFC 7946.
GeoJsonLineString

Platný typ geometrie GeoJSON LineString. Podrobnosti najdete v RFC 7946.
GeoJsonLineStringData
GeoJsonMultiLineString

Platný typ geometrie GeoJSON MultiLineString. Podrobnosti najdete v RFC 7946.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

Platný typ geometrie GeoJSON MultiPoint. Podrobnosti najdete v RFC 7946.
GeoJsonMultiPointData

Data obsažená GeoJson MultiPoint.
GeoJsonMultiPolygon

Platný typ objektu GeoJSON MultiPolygon. Podrobnosti najdete v RFC 7946.
GeoJsonMultiPolygonData
GeoJsonObjectParent

Platný objekt GeoJSON. Podrobnosti najdete v RFC 7946.
GeoJsonPoint

Platný typ geometrie GeoJSON Point. Podrobnosti najdete v RFC 7946.
GeoJsonPointData

Data obsažená GeoJson Point.
GeoJsonPolygon

Platný typ geometrie GeoJSON Polygon. Podrobnosti najdete v RFC 7946.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

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

Volitelné parametry klienta
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Parametry textu příspěvku pro směry trasy
RouteDirectionsBatchItemOutput

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

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

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

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

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

Rozhraní API Get Route Directions Batch je požadavek HTTP GET, který odesílá dávky dotazů do rozhraní Get Route Directions API pomocí jednoho požadavku. Můžete volat rozhraní API Get 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ů.

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:

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

  2. 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsBatch202Headers
RouteGetRouteDirectionsBatch202Response

Rozhraní API Get Route Directions Batch je požadavek HTTP GET, který odesílá dávky dotazů do rozhraní Get Route Directions API pomocí jednoho požadavku. Můžete volat rozhraní API Get 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ů.

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:

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

  2. 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."
                }
            }
        }
    ]
}
RouteGetRouteDirectionsDefaultResponse

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.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Rozhraní API Post Route Directions je požadavek HTTP POST, který vrací trasu mezi zdrojem a cílem, a pokud jsou zadány, prochází směrovacími body. Trasa bude brát 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. Podrobné vysvětlení konceptů a parametrů, které se týkají, najdete v modelu Consumption.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Rozhraní API Post Route Directions je požadavek HTTP POST, který vrací trasu mezi zdrojem a cílem, a pokud jsou zadány, prochází směrovacími body. Trasa bude brát 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. Podrobné vysvětlení konceptů a parametrů, které se týkají, najdete v modelu Consumption.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Rozhraní API Get Route Matrix je požadavek HTTP GET, který vypočítá dobu cesty a vzdálenost pro všechny možné páry v seznamu původu a cílů. Na rozdíl od rozhraní Get Route Directions API, které poskytují podrobné pokyny pro trasy, se toto rozhraní API zaměřuje na efektivitu tím, že poskytuje náklady na směrování (dobu cesty a vzdálenost) směrování z každého zdroje do každého cíle. Další informace najdete v tématu Osvědčené postupy pro službu Azure Maps Route.

Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Odeslat synchronní požadavek na matici tras

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

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

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

GET 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 GET směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek GET pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Rozhraní API Get Route Matrix je požadavek HTTP GET, který vypočítá dobu cesty a vzdálenost pro všechny možné páry v seznamu původu a cílů. Na rozdíl od rozhraní Get Route Directions API, které poskytují podrobné pokyny pro trasy, se toto rozhraní API zaměřuje na efektivitu tím, že poskytuje náklady na směrování (dobu cesty a vzdálenost) směrování z každého zdroje do každého cíle. Další informace najdete v tématu Osvědčené postupy pro službu Azure Maps Route.

Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Odeslat synchronní požadavek na matici tras

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

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

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

GET 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 GET směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek GET pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteGetRouteRange200Response

Rozhraní API Get Route Range (Isochrone) je požadavek HTTP GET, který vypočítá sadu umístění, která lze dosáhnout od počátečního bodu na základě zadaného rozpočtu na palivo, energii, čas nebo vzdálenost. Mnohoúhelník (neboli Isochrone) je vrácen v orientaci proti směru hodinových ručiček a přesný polygon střed, který byl výsledkem počátečního bodu.

Vrácený mnohoúhelník lze použít k dalšímu zpracování, jako je například Hledat uvnitř geometrie k vyhledání poi v zadané izochronu.
RouteGetRouteRangeDefaultResponse

Rozhraní API Get Route Range (Isochrone) je požadavek HTTP GET, který vypočítá sadu umístění, která lze dosáhnout od počátečního bodu na základě zadaného rozpočtu na palivo, energii, čas nebo vzdálenost. Mnohoúhelník (neboli Isochrone) je vrácen v orientaci proti směru hodinových ručiček a přesný polygon střed, který byl výsledkem počátečního bodu.

Vrácený mnohoúhelník lze použít k dalšímu zpracování, jako je například Hledat uvnitř geometrie k vyhledání poi v zadané izochronu.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

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

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

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

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

Objekt výsledku matice
RouteMatrixQuery

Objekt s maticí souřadnic.
RouteMatrixResultOutput

Tento objekt se vrátí z úspěšného volání matice směrování. Pokud jsou k dispozici 2 původy a 3 cíle, bude v každém z nich 2 pole se 3 prvky. Obsah jednotlivých prvků závisí na možnostech uvedených v dotazu.
RouteMatrixResultResponseOutput

Objekt odpovědi aktuální buňky ve vstupní matici
RouteMatrixSummaryOutput

Souhrnný objekt
RouteOptimizedWaypointOutput

Optimalizovaný objekt bodu cesty.
RouteOutput
RouteRangeOutput

Dosažitelný rozsah
RouteRangeResultOutput

Tento objekt se vrátí z úspěšného volání rozsahu dosažitelné trasy.
RouteReportOutput

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

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

  1. 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}

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

  2. 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}
  1. 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:

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

  2. 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatch202Headers
RouteRequestRouteDirectionsBatch202Response

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

  1. 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}

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

  2. 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}
  1. 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:

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

  2. 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchBodyParam
RouteRequestRouteDirectionsBatchMediaTypesParam
RouteRequestRouteDirectionsBatchSync200Response

Rozhraní API Post Route Directions Batch Sync je požadavek HTTP POST, který odesílá dávky dotazů do rozhraní Get Route Directions API pomocí jediné synchronní žádosti. 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 asynchronním požadavku, přečtěte si téma Směr směrování po směrování služby Batch.

Odeslat synchronní dávkový požadavek

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API.

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 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSync408Response

Rozhraní API Post Route Directions Batch Sync je požadavek HTTP POST, který odesílá dávky dotazů do rozhraní Get Route Directions API pomocí jediné synchronní žádosti. 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 asynchronním požadavku, přečtěte si téma Směr směrování po směrování služby Batch.

Odeslat synchronní dávkový požadavek

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API.

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 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncBodyParam
RouteRequestRouteDirectionsBatchSyncDefaultResponse

Rozhraní API Post Route Directions Batch Sync je požadavek HTTP POST, který odesílá dávky dotazů do rozhraní Get Route Directions API pomocí jediné synchronní žádosti. 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 asynchronním požadavku, přečtěte si téma Směr směrování po směrování služby Batch.

Odeslat synchronní dávkový požadavek

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné 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 omezený na 100 pro toto rozhraní API.

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 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."
                }
            }
        }
    ]
}
RouteRequestRouteDirectionsBatchSyncMediaTypesParam
RouteRequestRouteMatrix200Response

Rozhraní API Post Route Matrix je požadavek http POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí asynchronního (asynchronního) požadavku. Pokud chcete vytvořit synchronní (synchronizační) požadavek, přečtěte si Post Route Matrix Sync . Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Poznámka

Všechny původy a cíle by měly být obsaženy v osách zarovnaném 400 km x 400 km ohraničujícím rámečku. V opačném případě budou některé maticové buňky vyřešeny jako OUT_OF_REGION.

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení 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}

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

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 směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Rozhraní API Post Route Matrix je požadavek http POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí asynchronního (asynchronního) požadavku. Pokud chcete vytvořit synchronní (synchronizační) požadavek, přečtěte si Post Route Matrix Sync . Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Poznámka

Všechny původy a cíle by měly být obsaženy v osách zarovnaném 400 km x 400 km ohraničujícím rámečku. V opačném případě budou některé maticové buňky vyřešeny jako OUT_OF_REGION.

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení 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}

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

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 směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Rozhraní API Post Route Matrix Sync je požadavek HTTP POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí jediné synchronní (synchronizační) žádosti. Pokud chcete vytvořit asynchronní (asynchronní) požadavek, přečtěte si téma Post Route Matrix. Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení 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}

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

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 směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteRequestRouteMatrixSync408Response

Rozhraní API Post Route Matrix Sync je požadavek HTTP POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí jediné synchronní (synchronizační) žádosti. Pokud chcete vytvořit asynchronní (asynchronní) požadavek, přečtěte si téma Post Route Matrix. Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení 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}

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

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 směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Rozhraní API Post Route Matrix Sync je požadavek HTTP POST, který umožňuje výpočet matice souhrnů tras pro sadu tras definovaných zdroji a cílovými umístěními pomocí jediné synchronní (synchronizační) žádosti. Pokud chcete vytvořit asynchronní (asynchronní) požadavek, přečtěte si téma Post Route Matrix. Pro každý zdroj vypočítá služba náklady na směrování z tohoto zdroje do každého daného cíle. Sadu původů a množiny cílů si můžete představit jako záhlaví sloupců a řádků tabulky a každá buňka v tabulce obsahuje náklady na směrování ze zdroje do cíle dané buňky. Řekněme například, že společnost pro dodávku potravin má 20 řidičů a musí najít nejbližšího řidiče, který má vyzvednout dodávku z restaurace. K vyřešení tohoto případu použití můžou volat rozhraní API pro směrování matice.

Pro každou trasu se vrátí doba jízdy a vzdálenosti. Pomocí vypočítaných nákladů můžete určit, které podrobné trasy se mají vypočítat pomocí rozhraní API Směr trasy.

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

Odeslat synchronní požadavek na matici tras

Pokud váš scénář vyžaduje synchronní požadavky a maximální velikost matice je menší nebo rovna 100, možná budete chtít provést synchronní požadavek. Maximální velikost matice pro toto rozhraní API je 100 (počet původů vynásobený počtem cílů). S ohledem na toto omezení 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}

Odeslání požadavku na asynchronní matici tras

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů relativně složitých požadavků směrování. 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ě. Pokud je parametr waitForResults v požadavku nastavený na hodnotu true, uživatel obdrží odpověď 200, pokud je požadavek dokončen do 120 sekund.

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

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.

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 směrovací matice do Služby Azure Maps.

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

    HTTP 202 Accepted – Požadavek matice směrování byl přijat.

    HTTP Error – Při zpracování požadavku Route Matrix došlo k chybě. Může se jednat o chybný požadavek 400 nebo jakýkoli jiný stavový kód chyby.

  3. Pokud byl požadavek na maticovou trasu úspěšně přijat, hlavička Umístění 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í získanou v kroku 3 pro stažení výsledků.

Stažení výsledků synchronizace

Když provedete požadavek POST pro rozhraní API pro synchronizaci matice směrování, vrátí služba 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í asynchronních výsledků

Když žádost vydá odpověď 202 Accepted, požadavek se zpracovává pomocí našeho asynchronního kanálu. Dostanete adresu URL, abyste zkontrolovali průběh asynchronního požadavku v hlavičce umístění odpovědi. 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 zadaná hlavičkou umístění vrátí následující odpovědi při vydání GET požadavku.

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

HTTP 200 OK – požadavek matice byl úspěšně zpracován. Text odpovědi obsahuje všechny výsledky.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

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

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

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

Souhrnný objekt
Routes
SimplePollerLike

Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace.

Aliasy typu

GeoJsonGeometry

Platný objekt geometrie GeoJSON. Typ musí být jedním z sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v RFC 7946.
GeoJsonObject

Platný objekt GeoJSON. Podrobnosti najdete v RFC 7946.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Funkce

buildMultiCollection(string[], string)
createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Vytvořte tělo dávkové žádosti o skupinu žádostí o směr trasy.
default(AzureKeyCredential, ClientOptions)

Vytvoří instanci MapsRouteClient z klíče předplatného.

Příklad

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);
default(TokenCredential, string, ClientOptions)

Vytvoří instanci MapsRoute z azure Identity TokenCredential.

Příklad

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Vytvoří instanci MapsRoute z azure Identity AzureSASCredential.

Příklad

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Pomocná funkce, která vytvoří objekt Poller, který pomáhá dotazovat dlouho běžící operaci.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Transformujte pole [Latitude, Longtitute] na řetězec v následujícím formátu: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Podrobnosti funkce

buildMultiCollection(string[], string) 

function buildMultiCollection(items: string[], parameterName: string): string

Parametry

items

string[]

parameterName

string

Návraty

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Vytvořte tělo dávkové žádosti o skupinu žádostí o směr trasy.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parametry

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Objekt parametrů dotazu pro požadavek směr trasy

Návraty

BatchRequest

Složená dávková žádost.

default(AzureKeyCredential, ClientOptions)

Vytvoří instanci MapsRouteClient z klíče předplatného.

Příklad

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient

Parametry

credential
AzureKeyCredential

Instance AzureKeyCredential použitá k ověření požadavků na službu

options
ClientOptions

Možnosti používané ke konfiguraci klienta směrování

Návraty

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Vytvoří instanci MapsRoute z azure Identity TokenCredential.

Příklad

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient

Parametry

credential
TokenCredential

Instance TokenCredential použitá k ověření požadavků na službu

mapsAccountClientId

string

ID klienta Azure Maps konkrétního mapového prostředku

options
ClientOptions

Možnosti používané ke konfiguraci klienta směrování

Návraty

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Vytvoří instanci MapsRoute z azure Identity AzureSASCredential.

Příklad

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient

Parametry

credential
AzureSASCredential

Instance AzureSASCredential použitá k ověřování požadavků na službu

options
ClientOptions

Možnosti používané ke konfiguraci klienta směrování

Návraty

MapsRouteClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Pomocná funkce, která vytvoří objekt Poller, který pomáhá dotazovat dlouho běžící operaci.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parametry

client
Client

Klient, který se má použít k odeslání požadavku, aby získal další stránky.

initialResponse

TResult

Počáteční odpověď.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Možnosti nastavení stavu obnovení nebo vlastního intervalu dotazování

Návraty

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

  • Objekt poller, který se má dotazovat na aktualizace stavu operace, a nakonec získat konečnou odpověď.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse): response

Parametry

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Návraty

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parametry

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Návraty

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parametry

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Návraty

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parametry

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Návraty

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

function isUnexpected(response: RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse): response

Parametry

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Návraty

response

toColonDelimitedLatLonString(LatLon[])

Transformujte pole [Latitude, Longtitute] na řetězec v následujícím formátu: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parametry

coordinates

LatLon[]

Pole dvojice Zeměpisná šířka/Longtitute, která se má transformovat.

Návraty

string

Transformovaný řetězec.