Dela via

RequestRouteDirectionsBatchSync interface

  • Referens
Paket:
@azure-rest/maps-route

Metoder

post(RouteRequestRouteDirectionsBatchSyncParameters)

Post Route Directions Batch Sync-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda synkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Information om hur du anropar Post Route Directions Batch-API:et i en asynkron begäran finns i Batchpostrouteriktningar .

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

Metodinformation

post(RouteRequestRouteDirectionsBatchSyncParameters)

Post Route Directions Batch Sync-API:et är en HTTP-POST begäran som skickar batchar med frågor till Get Route Directions API med hjälp av en enda synkron begäran. Du kan anropa Route Directions Batch API för att köra antingen asynkront (asynkront) eller synkront (synkronisering). Med asynkront API kan anroparen batcha upp till 700 frågor och synkronisera API:et upp till 100 frågor. Information om hur du anropar Post Route Directions Batch-API:et i en asynkron begäran finns i Batchpostrouteriktningar .

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

Batch-svarsmodell

Det returnerade datainnehållet liknar asynkroniserings- och synkroniseringsbegäranden. När du laddar ned resultatet av en asynkron batchbegäran innehåller svarstexten batchsvaret om batchen har slutfört bearbetningen. Det här batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequestsdvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt i batchItems innehåller statusCode och response fält. Varje response i batchItems är av någon av följande typer:

  • RouteDirections – Om frågan har slutförts.

  • Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

Här är ett exempel på batchsvar med 1 lyckade och 1 misslyckades resultat:

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

function post(options: RouteRequestRouteDirectionsBatchSyncParameters): StreamableMethod<RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse>

Parametrar

options
RouteRequestRouteDirectionsBatchSyncParameters

Returer

StreamableMethod<RouteRequestRouteDirectionsBatchSync200Response | RouteRequestRouteDirectionsBatchSync408Response | RouteRequestRouteDirectionsBatchSyncDefaultResponse>