SearchGetGeocodingBatch200Response interface

Pacote:

@azure-rest/maps-search

A API é uma solicitação http que envia lotes de até 100 consultas para a API de de Geocodificação em uma única solicitação.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá nenhuma possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens em lote é limitado a 100 para essa API.

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

Corpo POST para solicitação em lote

Para enviar a consultas de de geocodificação, você usará uma solicitação POST em que o corpo da solicitação conterá a matriz batchItems no formato json e o cabeçalho Content-Type será definido como application/json. Aqui está um corpo de solicitação de exemplo que contém 2 consultas de de geocodificação :

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

Uma geocodificação objeto batchItem pode aceitar qualquer um dos parâmetros de URI dede geocodificação compatíveis.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica o totalRequests que faziam parte da solicitação em lote original e successfulRequests consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz de batchItems que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação em lote. Cada item é de um dos seguintes tipos:

• GeocodingResponse - Se a consulta foi concluída com êxito.

• Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.

Extends

HttpResponse

Propriedades

body
status

Propriedades herdadas

headers	Os cabeçalhos de resposta HTTP.
request	A solicitação que gerou essa resposta.

Detalhes da propriedade

body

body: GeocodingBatchResponseOutput

Valor da propriedade

GeocodingBatchResponseOutput

status

status: "200"

Valor da propriedade

"200"

Detalhes das propriedades herdadas

headers

Os cabeçalhos de resposta HTTP.

headers: RawHttpHeaders

Valor da propriedade

RawHttpHeaders

Herdado de HttpResponse.headers

request

A solicitação que gerou essa resposta.

request: PipelineRequest

Valor da propriedade

PipelineRequest

herdado de httpResponse.request