GetGeocodingBatch interface

La API de es una solicitud de HTTP que envía lotes de hasta 100 consultas a la API de de geocodificación en una sola solicitud.

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de de geocodificación , usará una solicitud de donde el cuerpo de la solicitud contendrá la matriz de en formato y el encabezado se establecerá en . Este es un cuerpo de solicitud de ejemplo que contiene 2 geocodificación consultas:

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

Un objeto geocodificación batchItem puede aceptar cualquiera de los parámetros de geocodificación URI admitidos.

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las 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 es de uno de los siguientes tipos:

• GeocodingResponse: 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.

function post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>

Parámetros

Devoluciones