RouteGetRouteDirectionsBatch202Response interface

Paquet:

@azure-rest/maps-route

L’API Get Route Directions Batch est une requête HTTP GET qui envoie des lots de requêtes à l’API Get Route Directions à l’aide d’une seule requête. Vous pouvez appeler Get Route Directions Batch API pour s’exécuter de manière asynchrone (asynchrone) ou synchrone (synchronisation). L’API asynchrone permet à l’appelant de traiter par lots jusqu’à 700 requêtes et de synchroniser l’API jusqu’à 100 requêtes.

Télécharger les résultats de lot asynchrones

Pour télécharger les résultats de lot asynchrones, vous émettrez une demande de GET sur le point de terminaison de téléchargement par lots. Cette 'URL de téléchargement peut être obtenue à partir de l’en-tête Location d’une demande de traitement par lots réussie POST et ressemble à ce qui suit :

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

Voici la séquence classique d’opérations pour télécharger les résultats du lot :

1. Le client envoie une demande de GET à l’aide de l’URL de téléchargement .

2. Le serveur répond avec l’une des options suivantes :

   HTTP 202 Accepted : la requête Batch a été acceptée mais est toujours traitée. Réessayez dans un certain temps.

   HTTP 200 OK - Requête batch correctement traitée. Le corps de la réponse contient tous les résultats du lot.

Modèle de réponse par lot

Le contenu de données retourné est similaire pour les demandes asynchrones et de synchronisation. Lors du téléchargement des résultats d’une demande de traitement asynchrone par lot, si le traitement du lot a terminé, le corps de la réponse contient la réponse par lot. Cette réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequestsc’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément de batchItems contient des champs statusCode et response. Chaque response dans batchItems est de l’un des types suivants :

• RouteDirections : si la requête s’est terminée correctement.

• Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.

Voici un exemple de réponse Batch avec 1 réussite et 1 échec résultat :

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

Propriétés

headers
status

Propriétés héritées

body	Corps analysé
request	Demande qui a généré cette réponse.

Détails de la propriété

headers

headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers

Valeur de propriété

RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers

status

status: "202"

Valeur de propriété

"202"

Détails de la propriété héritée

body

Corps analysé

body: unknown

Valeur de propriété

unknown

héritée de HttpResponse.body

request

Demande qui a généré cette réponse.

request: PipelineRequest

Valeur de propriété

PipelineRequest

héritée de HttpResponse.request