Udostępnij za pośrednictwem

@azure-rest/maps-route package

  • Odwołanie

Interfejsy

BatchRequest

Ten typ reprezentuje treść żądania dla usługi Batch.
BatchRequestItem

Obiekt żądania usługi Batch
BatchResultItemOutput

Element zwrócony z interfejsu API usługi Batch. Rozszerz za pomocą właściwości "response".
BatchResultOutput

Ten obiekt jest zwracany z pomyślnego wywołania usługi Batch. Rozszerz właściwość "batchItems".
BatchResultSummaryOutput

Podsumowanie wyników żądania wsadowego
EffectiveSettingOutput

Skuteczny parametr lub dane używane podczas wywoływania tego interfejsu API usługi Route.
ErrorDetailOutput

Szczegóły błędu.
ErrorResponseOutput

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
GeoJsonFeature

Prawidłowy typ obiektu GeoJSON Feature. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonFeatureCollection

Prawidłowy typ obiektu GeoJSON FeatureCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonFeatureCollectionData
GeoJsonFeatureData
GeoJsonGeometryCollection

Prawidłowy typ obiektu GeoJSON GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonGeometryCollectionData
GeoJsonGeometryParent

Prawidłowy obiekt geometrii GeoJSON. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonLineString

Prawidłowy typ geometrii GeoJSON LineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonLineStringData
GeoJsonMultiLineString

Prawidłowy typ geometrii GeoJSON MultiLineString. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiLineStringData
GeoJsonMultiPoint

Prawidłowy typ geometrii GeoJSON MultiPoint. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPointData

Dane zawarte w GeoJson MultiPoint.
GeoJsonMultiPolygon

Prawidłowy typ obiektu GeoJSON MultiPolygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonMultiPolygonData
GeoJsonObjectParent

Prawidłowy obiekt GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPoint

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPointData

Dane zawarte w GeoJson Point.
GeoJsonPolygon

Prawidłowy typ geometrii GeoJSON Polygon. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonPolygonData
GetRouteDirections
GetRouteRange
LatLongPairOutput

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna.
MapsRouteClientOptions

Opcjonalne parametry klienta
RequestRouteDirectionsBatch
RequestRouteDirectionsBatchSync
RequestRouteMatrix
RequestRouteMatrixSync
RouteDirectionParameters

Parametry po treści dla wskazówek trasy.
RouteDirectionsBatchItemOutput

Element zwrócony z wywołania usługi Route Directions Batch.
RouteDirectionsBatchItemResponseOutput

Wynik zapytania. RouteDirections, jeśli zapytanie zostało ukończone pomyślnie, ErrorResponse w przeciwnym razie.
RouteDirectionsBatchResultOutput

Ten obiekt jest zwracany z pomyślnego wywołania usługi Route Directions Batch.
RouteDirectionsOutput

Ten obiekt jest zwracany z pomyślnego wywołania Route Directions
RouteGetRouteDirections200Response

Interfejs API Get Route Directions to żądanie GET HTTP, które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty waypoints, jeśli określono. Trasa uwzględnia takie czynniki jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia.

Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje turn by turn, w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdów. Aby uzyskać więcej informacji, zobacz Consumption Model.
RouteGetRouteDirectionsBatch200Response

Interfejs API Get Route Directions Batch to żądanie GET HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania. Możesz wywołać interfejs API Get Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań.

Pobieranie wyników asynchronicznych wsadowych

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać żądanie GET do punktu końcowego pobierania wsadowego. Ten pobierania adresu URL można uzyskać z nagłówka Location pomyślnego żądania wsadowego POST i wygląda następująco:

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

Oto typowa sekwencja operacji pobierania wyników wsadowych:

  1. Klient wysyła żądanie GET przy użyciu adresu URL pobierania .

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

    200 OK HTTP — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Get Route Directions Batch to żądanie GET HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania. Możesz wywołać interfejs API Get Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań.

Pobieranie wyników asynchronicznych wsadowych

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać żądanie GET do punktu końcowego pobierania wsadowego. Ten pobierania adresu URL można uzyskać z nagłówka Location pomyślnego żądania wsadowego POST i wygląda następująco:

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

Oto typowa sekwencja operacji pobierania wyników wsadowych:

  1. Klient wysyła żądanie GET przy użyciu adresu URL pobierania .

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

    200 OK HTTP — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Get Route Directions to żądanie GET HTTP, które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty waypoints, jeśli określono. Trasa uwzględnia takie czynniki jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia.

Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje turn by turn, w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdów. Aby uzyskać więcej informacji, zobacz Consumption Model.
RouteGetRouteDirectionsQueryParam
RouteGetRouteDirectionsQueryParamProperties
RouteGetRouteDirectionsWithAdditionalParameters200Response

Interfejs API Post Route Directions to żądanie POST HTTP, które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty drogi, jeśli zostały określone. Trasa będzie uwzględniać czynniki, takie jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia.

Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje turn by turn, w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdu. Aby uzyskać szczegółowe wyjaśnienie pojęć i parametrów, zobacz Consumption Model.
RouteGetRouteDirectionsWithAdditionalParametersBodyParam
RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Interfejs API Post Route Directions to żądanie POST HTTP, które zwraca trasę między źródłem a miejscem docelowym, przechodząc przez punkty drogi, jeśli zostały określone. Trasa będzie uwzględniać czynniki, takie jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia.

Zwrócone informacje obejmują odległość, szacowany czas podróży i reprezentację geometrii trasy. Dostępne są również dodatkowe informacje dotyczące routingu, takie jak zoptymalizowana kolejność punktów waypoint lub instrukcje turn by turn, w zależności od wybranych opcji.

Usługa routingu udostępnia zestaw parametrów dla szczegółowego opisu modelu zużycia specyficznego dla pojazdu. Aby uzyskać szczegółowe wyjaśnienie pojęć i parametrów, zobacz Consumption Model.
RouteGetRouteDirectionsWithAdditionalParametersMediaTypesParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParam
RouteGetRouteDirectionsWithAdditionalParametersQueryParamProperties
RouteGetRouteMatrix200Response

Interfejs API Get Route Matrix to żądanie GET HTTP, które oblicza czas podróży i odległość dla wszystkich możliwych par na liście źródeł i miejsc docelowych. W przeciwieństwie do interfejsu API Get Route Directions, który udostępnia szczegółowe instrukcje dotyczące trasy, ten interfejs API koncentruje się na wydajności, zapewniając koszt (czas podróży i odległość) routingu z każdego punktu początkowego do każdego miejsca docelowego. Aby uzyskać więcej informacji, zobacz Best practices for Azure Maps Route Service.

Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie GET macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania GET dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteGetRouteMatrix202Headers
RouteGetRouteMatrix202Response

Interfejs API Get Route Matrix to żądanie GET HTTP, które oblicza czas podróży i odległość dla wszystkich możliwych par na liście źródeł i miejsc docelowych. W przeciwieństwie do interfejsu API Get Route Directions, który udostępnia szczegółowe instrukcje dotyczące trasy, ten interfejs API koncentruje się na wydajności, zapewniając koszt (czas podróży i odległość) routingu z każdego punktu początkowego do każdego miejsca docelowego. Aby uzyskać więcej informacji, zobacz Best practices for Azure Maps Route Service.

Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie GET macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania GET dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteGetRouteRange200Response

Interfejs API Get Route Range (Isochrone) to żądanie GET HTTP, które oblicza zestaw lokalizacji, które można uzyskać z punktu początkowego na podstawie określonego paliwa, energii, czasu lub budżetu odległości. Granica wielokąta (lub Isochrone) jest zwracana w orientacji odwrotnej, a także dokładnego środka wielokąta, który był wynikiem punktu początkowego.

Zwrócony wielokąt może służyć do dalszego przetwarzania, takiego jak Search Inside Geometry w celu wyszukiwania punktów weryfikacji w ramach podanego izochronu.
RouteGetRouteRangeDefaultResponse

Interfejs API Get Route Range (Isochrone) to żądanie GET HTTP, które oblicza zestaw lokalizacji, które można uzyskać z punktu początkowego na podstawie określonego paliwa, energii, czasu lub budżetu odległości. Granica wielokąta (lub Isochrone) jest zwracana w orientacji odwrotnej, a także dokładnego środka wielokąta, który był wynikiem punktu początkowego.

Zwrócony wielokąt może służyć do dalszego przetwarzania, takiego jak Search Inside Geometry w celu wyszukiwania punktów weryfikacji w ramach podanego izochronu.
RouteGetRouteRangeQueryParam
RouteGetRouteRangeQueryParamProperties
RouteGuidanceOutput

Zawiera elementy powiązane ze wskazówkami. To pole jest obecne tylko wtedy, gdy zażądano wskazówek i jest dostępne.
RouteInstructionGroupOutput

Grupuje sekwencję elementów instrukcji, które są ze sobą powiązane. Zakres sekwencji jest ograniczony za pomocą parametru firstInstructionIndex i lastInstructionIndex. Gdy żądania dotyczące komunikatów tekstowych z możliwością odczytu przez człowieka są wymagane w celu uzyskania wskazówek (instrukcjaType=tekst lub tag), wówczas w grupie instrukcji jest zwracany komunikat podsumowania, gdy jest dostępny.
RouteInstructionOutput

Zestaw atrybutów opisujących manewr, np. "Turn right", "Keep left", "Take the ferry", "Take the highway", "Arrive".
RouteLegOutput

Opis części trasy składający się z listy punktów. Każdy dodatkowy punkt waypoint podany w żądaniu spowoduje dodatkową nogę w zwróconej trasie.
RouteMatrixOutput

Obiekt wynikowy macierzy
RouteMatrixQuery

Obiekt z macierzą współrzędnych.
RouteMatrixResultOutput

Ten obiekt jest zwracany z pomyślnego wywołania macierzy tras. Na przykład jeśli podano 2 źródła i 3 miejsca docelowe, w każdej z nich będzie 2 tablice z 3 elementami. Zawartość każdego elementu zależy od opcji podanych w zapytaniu.
RouteMatrixResultResponseOutput

Obiekt odpowiedzi bieżącej komórki w macierzy wejściowej.
RouteMatrixSummaryOutput

Obiekt podsumowania
RouteOptimizedWaypointOutput

Zoptymalizowany obiekt punktu drogi.
RouteOutput
RouteRangeOutput

Osiągalny zakres
RouteRangeResultOutput

Ten obiekt jest zwracany z pomyślnego wywołania zakresu osiągalnego trasy
RouteReportOutput

Raportuje obowiązujące ustawienia używane w bieżącym wywołaniu.
RouteRequestRouteDirectionsBatch200Response

Interfejs API Post Route Directions Batch to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania asynchronicznego. Możesz wywołać interfejs API Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań. Aby wywołać interfejs API Post Route Directions Batch w żądaniu synchronicznym, zobacz Post Route Directions Batch Sync.

Przesyłanie asynchronicznego żądania usługi Batch

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań tras

  • Umożliwia pobieranie wyników w osobnym wywołaniu (możliwe jest wiele pobrań).
  • Asynchroniczny interfejs API jest zoptymalizowany pod kątem niezawodności i nie oczekuje się, że upłynął limit czasu.
  • Liczba elementów wsadowych jest ograniczona do 700 dla tego interfejsu API.

Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

Należy pamiętać, że asynchroniczne żądanie wsadowe jest długotrwałą operacją. Oto typowa sekwencja operacji:

  1. Klient wysyła żądanie usługi Batch Directions Routes POST do usługi Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania usługi Batch. Może to być 400 Bad Request lub inny kod stanu Error.

  2. Jeśli żądanie wsadowe zostało pomyślnie zaakceptowane, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania wsadowego. Ten identyfikator URI stanu wygląda następująco:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient wysyła żądanie GET na adres URL pobierania uzyskany w kroku 3 w celu pobrania wyników wsadowych.

Treść POST dla żądania wsadowego

Aby wysłać wskazówki tras zapytania, użyjesz żądania POST, w którym treść żądania będzie zawierać tablicę batchItems w formacie json, a nagłówek Content-Type zostanie ustawiony na wartość application/json. Oto przykładowa treść żądania zawierająca 3 wskazówki dotyczące tras zapytań:

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

Wskazówki kierowania zapytania w partii to tylko częściowy adres URL bez protokołu, podstawowego adresu URL, ścieżki, wersji interfejsu API i klucza subskrypcji. Może zaakceptować dowolny z obsługiwanych wskazówek trasparametrów identyfikatora URI. Wartości ciągów w kierunkach trasy kwerendy muszą być prawidłowo uniknięte (np. "znak powinien zostać uniknięta znakiem \ ), a także powinien być prawidłowo zakodowany pod adresem URL.

Asynchroniczny interfejs API umożliwia obiektowi wywołującym wykonywanie partii do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań, a partia powinna zawierać co najmniej 1 zapytania.

Pobieranie wyników asynchronicznych wsadowych

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać żądanie GET do punktu końcowego pobierania wsadowego. Ten pobierania adresu URL można uzyskać z nagłówka Location pomyślnego żądania wsadowego POST i wygląda następująco:

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

Oto typowa sekwencja operacji pobierania wyników wsadowych:

  1. Klient wysyła żądanie GET przy użyciu adresu URL pobierania .

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

    200 OK HTTP — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Post Route Directions Batch to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania asynchronicznego. Możesz wywołać interfejs API Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań. Aby wywołać interfejs API Post Route Directions Batch w żądaniu synchronicznym, zobacz Post Route Directions Batch Sync.

Przesyłanie asynchronicznego żądania usługi Batch

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań tras

  • Umożliwia pobieranie wyników w osobnym wywołaniu (możliwe jest wiele pobrań).
  • Asynchroniczny interfejs API jest zoptymalizowany pod kątem niezawodności i nie oczekuje się, że upłynął limit czasu.
  • Liczba elementów wsadowych jest ograniczona do 700 dla tego interfejsu API.

Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

Należy pamiętać, że asynchroniczne żądanie wsadowe jest długotrwałą operacją. Oto typowa sekwencja operacji:

  1. Klient wysyła żądanie usługi Batch Directions Routes POST do usługi Azure Maps.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}

  1. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania usługi Batch. Może to być 400 Bad Request lub inny kod stanu Error.

  2. Jeśli żądanie wsadowe zostało pomyślnie zaakceptowane, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania wsadowego. Ten identyfikator URI stanu wygląda następująco:

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient wysyła żądanie GET na adres URL pobierania uzyskany w kroku 3 w celu pobrania wyników wsadowych.

Treść POST dla żądania wsadowego

Aby wysłać wskazówki tras zapytania, użyjesz żądania POST, w którym treść żądania będzie zawierać tablicę batchItems w formacie json, a nagłówek Content-Type zostanie ustawiony na wartość application/json. Oto przykładowa treść żądania zawierająca 3 wskazówki dotyczące tras zapytań:

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

Wskazówki kierowania zapytania w partii to tylko częściowy adres URL bez protokołu, podstawowego adresu URL, ścieżki, wersji interfejsu API i klucza subskrypcji. Może zaakceptować dowolny z obsługiwanych wskazówek trasparametrów identyfikatora URI. Wartości ciągów w kierunkach trasy kwerendy muszą być prawidłowo uniknięte (np. "znak powinien zostać uniknięta znakiem \ ), a także powinien być prawidłowo zakodowany pod adresem URL.

Asynchroniczny interfejs API umożliwia obiektowi wywołującym wykonywanie partii do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań, a partia powinna zawierać co najmniej 1 zapytania.

Pobieranie wyników asynchronicznych wsadowych

Aby pobrać wyniki asynchronicznego pobierania wsadowego, należy wysłać żądanie GET do punktu końcowego pobierania wsadowego. Ten pobierania adresu URL można uzyskać z nagłówka Location pomyślnego żądania wsadowego POST i wygląda następująco:

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

Oto typowa sekwencja operacji pobierania wyników wsadowych:

  1. Klient wysyła żądanie GET przy użyciu adresu URL pobierania .

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie usługi Batch zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

    200 OK HTTP — pomyślnie przetworzone żądanie usługi Batch. Treść odpowiedzi zawiera wszystkie wyniki wsadowe.

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Post Route Directions Batch Sync to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania synchronicznego. Możesz wywołać interfejs API Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań. Aby wywołać interfejs API Post Route Directions Batch w asynchronicznym żądaniu, zobacz Post Route Directions Batch.

Przesyłanie synchronicznego żądania usługi Batch

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

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

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Post Route Directions Batch Sync to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania synchronicznego. Możesz wywołać interfejs API Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań. Aby wywołać interfejs API Post Route Directions Batch w asynchronicznym żądaniu, zobacz Post Route Directions Batch.

Przesyłanie synchronicznego żądania usługi Batch

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

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

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Post Route Directions Batch Sync to żądanie POST HTTP, które wysyła partie zapytań do interfejsu API Get Route Directions przy użyciu pojedynczego żądania synchronicznego. Możesz wywołać interfejs API Route Directions Batch, aby uruchomić asynchronicznie (asynchronicznie) lub synchronicznie (synchronizacja). Asynchroniczny interfejs API umożliwia wywołaniu wsadowe do 700 zapytań i synchronizowanie interfejsu API do 100 zapytań. Aby wywołać interfejs API Post Route Directions Batch w asynchronicznym żądaniu, zobacz Post Route Directions Batch.

Przesyłanie synchronicznego żądania usługi Batch

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

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

Model odpowiedzi wsadowej

Zwrócona zawartość danych jest podobna dla żądań asynchronicznych i synchronizacji. Podczas pobierania wyników asynchronicznego żądania wsadowego, jeśli partia zakończyła przetwarzanie, treść odpowiedzi zawiera odpowiedź wsadową. Ta odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequeststj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element w batchItems zawiera pola statusCode i response. Każdy response w batchItems jest jednym z następujących typów:

  • RouteDirections — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Oto przykładowa odpowiedź wsadowa z wynikiem 1 i 1 zakończyła się niepowodzeniem:

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

Interfejs API Post Route Matrix to żądanie POST HTTP, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu żądania asynchronicznego (asynchronicznego). Aby utworzyć żądanie synchroniczne (synchronizacja), zobacz Post Route Matrix Sync. Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Uwaga

Wszystkie źródła i miejsca docelowe powinny znajdować się w polu ograniczenia osi 400 km x 400 km. W przeciwnym razie niektóre komórki macierzy zostaną rozpoznane jako OUT_OF_REGION.

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie POST macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania POST dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteRequestRouteMatrix202Headers
RouteRequestRouteMatrix202Response

Interfejs API Post Route Matrix to żądanie POST HTTP, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu żądania asynchronicznego (asynchronicznego). Aby utworzyć żądanie synchroniczne (synchronizacja), zobacz Post Route Matrix Sync. Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Uwaga

Wszystkie źródła i miejsca docelowe powinny znajdować się w polu ograniczenia osi 400 km x 400 km. W przeciwnym razie niektóre komórki macierzy zostaną rozpoznane jako OUT_OF_REGION.

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie POST macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania POST dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteRequestRouteMatrixBodyParam
RouteRequestRouteMatrixMediaTypesParam
RouteRequestRouteMatrixQueryParam
RouteRequestRouteMatrixQueryParamProperties
RouteRequestRouteMatrixSync200Response

Interfejs API Post Route Matrix Sync to żądanie POST HTTP, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu pojedynczego żądania synchronicznego (synchronizacji). Aby utworzyć żądanie asynchroniczne (asynchroniczne), zobacz Post Route Matrix. Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie POST macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania POST dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteRequestRouteMatrixSync408Response

Interfejs API Post Route Matrix Sync to żądanie POST HTTP, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu pojedynczego żądania synchronicznego (synchronizacji). Aby utworzyć żądanie asynchroniczne (asynchroniczne), zobacz Post Route Matrix. Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie POST macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania POST dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteRequestRouteMatrixSyncBodyParam
RouteRequestRouteMatrixSyncDefaultResponse

Interfejs API Post Route Matrix Sync to żądanie POST HTTP, które umożliwia obliczenie macierzy podsumowań tras dla zestawu tras zdefiniowanych przez lokalizacje początkowe i docelowe przy użyciu pojedynczego żądania synchronicznego (synchronizacji). Aby utworzyć żądanie asynchroniczne (asynchroniczne), zobacz Post Route Matrix. Dla każdego danego źródła usługa oblicza koszt routingu z tego źródła do każdego miejsca docelowego. Zestaw źródeł i zestaw miejsc docelowych można traktować jako nagłówki kolumn i wierszy tabeli, a każda komórka w tabeli zawiera koszty routingu z punktu początkowego do miejsca docelowego dla tej komórki. Załóżmy na przykład, że firma dostarczająca żywność ma 20 kierowców i musi znaleźć najbliższego kierowcę, aby odebrać dostawę z restauracji. Aby rozwiązać ten przypadek użycia, mogą wywołać interfejs API trasy macierzy.

Dla każdej trasy zwracane są czasy podróży i odległości. Za pomocą obliczonych kosztów można określić, które szczegółowe trasy mają być obliczane przy użyciu interfejsu API Route Directions.

Maksymalny rozmiar macierzy dla żądania asynchronicznego to 700, a żądanie synchronizacji to 100 (liczba źródeł pomnożonych przez liczbę miejsc docelowych).

Przesyłanie synchronicznego żądania macierzy tras

Jeśli scenariusz wymaga żądań synchronicznych, a maksymalny rozmiar macierzy jest mniejszy lub równy 100, możesz utworzyć żądanie synchroniczne. Maksymalny rozmiar macierzy dla tego interfejsu API to 100 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając na uwadze to ograniczenie, przykłady możliwych wymiarów macierzy to: 10x10, 6x8, 9x8 (nie musi być kwadratowy).

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

Prześlij żądanie asynchronicznej macierzy tras

Interfejs API asynchroniczny jest odpowiedni do przetwarzania dużych ilości stosunkowo złożonych żądań routingu. Gdy wysyłasz żądanie przy użyciu żądania asynchronicznego, domyślnie usługa zwraca kod odpowiedzi 202 wraz z adresem URL przekierowania w polu Lokalizacja nagłówka odpowiedzi. Ten adres URL powinien być okresowo sprawdzany do momentu udostępnienia danych odpowiedzi lub informacji o błędzie. Jeśli parametr waitForResults w żądaniu ma wartość true, użytkownik otrzyma odpowiedź 200, jeśli żądanie zostanie zakończone poniżej 120 sekund.

Maksymalny rozmiar macierzy dla tego interfejsu API to 700 (liczba źródeł pomnożona przez liczbę miejsc docelowych). Mając to na uwadze, przykłady możliwych wymiarów macierzy to: 50x10, 10x10, 28x25. 10x70 (nie musi być kwadratowy).

Odpowiedzi asynchroniczne są przechowywane przez 24 godzin. Adres URL przekierowania zwraca odpowiedź 404, jeśli jest używana po upływie okresu wygaśnięcia.

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

Oto typowa sekwencja operacji asynchronicznych:

  1. Klient wysyła żądanie POST macierzy tras do usługi Azure Maps

  2. Serwer odpowie jednym z następujących elementów:

    202 Accepted HTTP — żądanie macierzy tras zostało zaakceptowane.

    Error HTTP — wystąpił błąd podczas przetwarzania żądania macierzy tras. Może to być 400 Nieprawidłowe żądanie lub inny kod stanu błędu.

  3. Jeśli żądanie trasy macierzy zostało zaakceptowane pomyślnie, nagłówek Location w odpowiedzi zawiera adres URL umożliwiający pobranie wyników żądania. Ten identyfikator URI stanu wygląda następująco:

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}
  1. Klient wystawia żądanie GET w adresie URL pobierania uzyskanym w kroku 3, aby pobrać wyniki

Pobieranie wyników synchronizacji

Po wysłaniu żądania POST dla interfejsu API synchronizacji macierzy tras usługa zwraca kod odpowiedzi 200 dla pomyślnego żądania i tablicy odpowiedzi. Treść odpowiedzi będzie zawierać dane i nie będzie można pobrać wyników później.

Pobieranie wyników asynchronicznych

Gdy żądanie wysyła 202 Accepted odpowiedzi, żądanie jest przetwarzane przy użyciu naszego potoku asynchronicznego. Otrzymasz adres URL, aby sprawdzić postęp żądania asynchronicznego w nagłówku lokalizacji odpowiedzi. Ten identyfikator URI stanu wygląda następująco:

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

Adres URL podany przez nagłówek lokalizacji zwróci następujące odpowiedzi po wysłaniu żądania GET.

202 Accepted HTTP — żądanie macierzy zostało zaakceptowane, ale nadal jest przetwarzane. Spróbuj ponownie za jakiś czas.

200 OK HTTP — pomyślnie przetworzone żądanie macierzy. Treść odpowiedzi zawiera wszystkie wyniki.
RouteRequestRouteMatrixSyncMediaTypesParam
RouteRequestRouteMatrixSyncQueryParam
RouteRequestRouteMatrixSyncQueryParamProperties
RouteSectionOutput

Sekcje trasy zawierają dodatkowe informacje o częściach trasy. Każda sekcja zawiera co najmniej elementy startPointIndex, endPointIndexi sectionType.
RouteSectionTecCauseOutput

Przyczyna zdarzenia ruchu. Może zawierać elementy mainCauseCode i subCauseCode. Może służyć do definiowania ikonografii i opisów.
RouteSectionTecOutput

Szczegółowe informacje o zdarzeniu ruchu przy użyciu definicji w standardzie TPEG2-TEC. Może zawierać efektCode i powoduje elementy.
RouteSummaryOutput

Obiekt podsumowania
Routes
SimplePollerLike

Prosty poller, który może służyć do sondowania długotrwałej operacji.

Aliasy typu

GeoJsonGeometry

Prawidłowy obiekt geometrii GeoJSON. Typ musi być jednym z siedmiu prawidłowych typów geometrii GeoJSON — Punkt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon i GeometryCollection. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
GeoJsonObject

Prawidłowy obiekt GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
MapsRouteClient
RouteGetRouteDirectionsBatchParameters
RouteGetRouteDirectionsParameters
RouteGetRouteDirectionsWithAdditionalParametersParameters
RouteGetRouteMatrixParameters
RouteGetRouteRangeParameters
RouteRequestRouteDirectionsBatchParameters
RouteRequestRouteDirectionsBatchSyncParameters
RouteRequestRouteMatrixParameters
RouteRequestRouteMatrixSyncParameters

Funkcje

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

Utwórz treść żądania wsadowego dla wielu żądań kierunku trasy.
default(AzureKeyCredential, ClientOptions)

Tworzy wystąpienie elementu MapsRouteClient na podstawie klucza subskrypcji.

Przykład

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)

Tworzy wystąpienie usługi MapsRoute na podstawie usługi Azure Identity TokenCredential.

Przykład

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)

Tworzy wystąpienie usługi MapsRoute na podstawie usługi Azure Identity AzureSASCredential.

Przykład

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>>)

Funkcja pomocnika, która tworzy obiekt Poller, aby ułatwić sondowanie długotrwałej operacji.
isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse)
isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse)
isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse)
isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse)
isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse)
toColonDelimitedLatLonString(LatLon[])

Przekształć tablicę [Latitude, Longtitute] na ciąg w następującym formacie: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

Szczegóły funkcji

buildMultiCollection(string[], string) 

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

Parametry

items

string[]

parameterName

string

Zwraca

string

createRouteDirectionsBatchRequest(RouteGetRouteDirectionsQueryParamProperties[])

Utwórz treść żądania wsadowego dla wielu żądań kierunku trasy.

function createRouteDirectionsBatchRequest(queryParamProperties: RouteGetRouteDirectionsQueryParamProperties[]): BatchRequest

Parametry

queryParamProperties

RouteGetRouteDirectionsQueryParamProperties[]

Obiekt parametrów zapytania dla żądania kierunku trasy

Zwraca

BatchRequest

Skomponowane żądanie wsadowe.

default(AzureKeyCredential, ClientOptions)

Tworzy wystąpienie elementu MapsRouteClient na podstawie klucza subskrypcji.

Przykład

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

Wystąpienie azureKeyCredential używane do uwierzytelniania żądań w usłudze

options
ClientOptions

Opcje używane do konfigurowania klienta routingu

Zwraca

MapsRouteClient

default(TokenCredential, string, ClientOptions)

Tworzy wystąpienie usługi MapsRoute na podstawie usługi Azure Identity TokenCredential.

Przykład

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

Wystąpienie TokenCredential używane do uwierzytelniania żądań w usłudze

mapsAccountClientId

string

Identyfikator klienta usługi Azure Maps określonego zasobu mapy

options
ClientOptions

Opcje używane do konfigurowania klienta routingu

Zwraca

MapsRouteClient

default(AzureSASCredential, ClientOptions)

Tworzy wystąpienie usługi MapsRoute na podstawie usługi Azure Identity AzureSASCredential.

Przykład

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

Wystąpienie AzureSASCredential używane do uwierzytelniania żądań w usłudze

options
ClientOptions

Opcje używane do konfigurowania klienta routingu

Zwraca

MapsRouteClient

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

Funkcja pomocnika, która tworzy obiekt Poller, aby ułatwić sondowanie długotrwałej operacji.

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

Parametry

client
Client

Klient do użycia do wysyłania żądania w celu uzyskania dodatkowych stron.

initialResponse

TResult

Początkowa odpowiedź.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Opcje ustawiania stanu wznowienia lub niestandardowego interwału sondowania.

Zwraca

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

  • Obiekt poller do sondowania pod kątem aktualizacji stanu operacji i ostatecznie uzyskać ostateczną odpowiedź.

isUnexpected(RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse) 

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

Parametry

response

RouteRequestRouteMatrixSync200Response | RouteRequestRouteMatrixSync408Response | RouteRequestRouteMatrixSyncDefaultResponse

Zwraca

response

isUnexpected(RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse): response

Parametry

response

RouteGetRouteDirections200Response | RouteGetRouteDirectionsDefaultResponse

Zwraca

response

isUnexpected(RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse) 

function isUnexpected(response: RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse): response

Parametry

response

RouteGetRouteDirectionsWithAdditionalParameters200Response | RouteGetRouteDirectionsWithAdditionalParametersDefaultResponse

Zwraca

response

isUnexpected(RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse) 

function isUnexpected(response: RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse): response

Parametry

response

RouteGetRouteRange200Response | RouteGetRouteRangeDefaultResponse

Zwraca

response

isUnexpected(RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse) 

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

Parametry

response

RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse

Zwraca

response

toColonDelimitedLatLonString(LatLon[])

Przekształć tablicę [Latitude, Longtitute] na ciąg w następującym formacie: "Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:..."

function toColonDelimitedLatLonString(coordinates: LatLon[]): string

Parametry

coordinates

LatLon[]

Tablica pary Latitude/Longtitute do przekształcenia.

Zwraca

string

Przekształcony ciąg.