Sdílet prostřednictvím

RouteGetRouteDirectionsBatch200Response interface

  • Reference
Balíček:
@azure-rest/maps-route

Rozhraní API Get Route Directions Batch je požadavek HTTP GET, který odesílá dávky dotazů do rozhraní Get Route Directions API pomocí jednoho požadavku. Můžete volat rozhraní API Get Route Directions Batch tak, aby se spustilo asynchronně (async), nebo synchronně (synchronně). Asynchronní rozhraní API umožňuje volajícímu dávkovat až 700 dotazů a synchronizovat rozhraní API až do 100 dotazů.

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

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

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

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

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

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

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

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

Model dávkové odpovědi

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

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

  • Error – Pokud dotaz selhal. Odpověď bude obsahovat code a v tomto případě message.

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

{
    "summary": {
        "successfulRequests": 1,
        "totalRequests": 2
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response": {
                "routes": [
                    {
                        "summary": {
                            "lengthInMeters": 1758,
                            "travelTimeInSeconds": 387,
                            "trafficDelayInSeconds": 0,
                            "departureTime": "2018-07-17T00:49:56+00:00",
                            "arrivalTime": "2018-07-17T00:56:22+00:00"
                        },
                        "legs": [
                            {
                                "summary": {
                                    "lengthInMeters": 1758,
                                    "travelTimeInSeconds": 387,
                                    "trafficDelayInSeconds": 0,
                                    "departureTime": "2018-07-17T00:49:56+00:00",
                                    "arrivalTime": "2018-07-17T00:56:22+00:00"
                                },
                                "points": [
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.34892
                                    },
                                    {
                                        "latitude": 47.62094,
                                        "longitude": -122.3485
                                    },
                                    {
                                        "latitude": 47.62095,
                                        "longitude": -122.3476
                                    }
                                ]
                            }
                        ],
                        "sections": [
                            {
                                "startPointIndex": 0,
                                "endPointIndex": 40,
                                "sectionType": "TRAVEL_MODE",
                                "travelMode": "bicycle"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Extends
HttpResponse

Vlastnosti

body
status

Zděděné vlastnosti

headers

Hlavičky odpovědi HTTP.
request

Požadavek, který vygeneroval tuto odpověď.

Podrobnosti vlastnosti

body 

body: RouteDirectionsBatchResultOutput

Hodnota vlastnosti

RouteDirectionsBatchResultOutput

status 

status: "200"

Hodnota vlastnosti

"200"

Podrobnosti zděděných vlastností

headers

Hlavičky odpovědi HTTP.

headers: RawHttpHeaders

Hodnota vlastnosti

RawHttpHeaders

zděděno z httpResponse.headers

request

Požadavek, který vygeneroval tuto odpověď.

request: PipelineRequest

Hodnota vlastnosti

PipelineRequest

zděděno z HttpResponse.request