Compartir a través de


RouteGetRouteDirectionsBatch202Response interface

La API de Get Route Directions Batch es una solicitud de GET HTTP que envía lotes de consultas a la API Get Route Directions mediante una sola solicitud. Puede llamar a Get Route Directions Batch API para que se ejecute de forma asincrónica (asincrónica) o sincrónica (sincrónica). La API asincrónica permite al autor de la llamada procesar por lotes hasta 700 consultas y sincronizar la API hasta 100 consultas.

Descargar resultados de lotes asincrónicos

Para descargar los resultados del lote asincrónico, emitirá una solicitud de GET al punto de conexión de descarga por lotes. Esta dirección URL de descarga se puede obtener del encabezado Location de una solicitud por lotes de POST correcta y tiene el siguiente aspecto:

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

Esta es la secuencia típica de operaciones para descargar los resultados del lote:

  1. El cliente envía una solicitud de GET mediante la dirección URL de descarga de .

  2. El servidor responderá con uno de los siguientes elementos:

    HTTP 202 Accepted: se aceptó la solicitud por lotes, pero todavía se está procesando. Inténtelo de nuevo en algún momento.

    HTTP 200 OK: solicitud de Batch procesada correctamente. El cuerpo de la respuesta contiene todos los resultados del lote.

Modelo de respuesta por lotes

El contenido de datos devuelto es similar para las solicitudes asincrónicas y de sincronización. Al descargar los resultados de una solicitud por lotes asincrónica, si el lote ha terminado de procesarse, el cuerpo de la respuesta contiene la respuesta por lotes. Esta respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequestses decir, consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento de batchItems contiene campos statusCode y response. Cada response de batchItems es de uno de los siguientes tipos:

  • RouteDirections: si la consulta se completó correctamente.

  • Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

Esta es una respuesta por lotes de ejemplo con 1 correcto y 1 error resultado:

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

Propiedades

headers
status

Propiedades heredadas

body

Cuerpo analizado

request

Solicitud que generó esta respuesta.

Detalles de las propiedades

headers

headers: RawHttpHeaders & RouteGetRouteDirectionsBatch202Headers

Valor de propiedad

status

status: "202"

Valor de propiedad

"202"

Detalles de las propiedades heredadas

body

Cuerpo analizado

body: unknown

Valor de propiedad

unknown

Heredado de HttpResponse.body

request

Solicitud que generó esta respuesta.

request: PipelineRequest

Valor de propiedad

Heredado de HttpResponse.request