Udostępnij za pośrednictwem

RouteGetRouteDirectionsBatch202Response interface

  • Odwołanie
Pakiet:
@azure-rest/maps-route

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

Właściwości

headers
status

Właściwości dziedziczone

body

Przeanalizowana treść
request

Żądanie, które wygenerowało tę odpowiedź.

Szczegóły właściwości

headers 

headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers

Wartość właściwości

RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers

status 

status: "202"

Wartość właściwości

"202"

Szczegóły właściwości dziedziczonej

body

Przeanalizowana treść

body: unknown

Wartość właściwości

unknown

dziedziczone z HttpResponse.body

request

Żądanie, które wygenerowało tę odpowiedź.

request: PipelineRequest

Wartość właściwości

PipelineRequest

dziedziczone z HttpResponse.request