Partilhar via

GetGeocodingBatch interface

  • Referência
Pacote:
@azure-rest/maps-search

Métodos

post(SearchGetGeocodingBatchParameters)

A API Get Geocoding Batch é uma solicitação de POST HTTP que envia lotes de até 100 consultas para a Geocoding API em uma única solicitação.

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação de lote

Para enviar as consultas de geocodificação você usará uma solicitação de onde o corpo da solicitação conterá a matriz em formato e o cabeçalho será definido como . Aqui está um corpo de solicitação de exemplo contendo 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 URIgeocodificação suportados.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item é de um dos seguintes tipos:

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

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

Detalhes de Método

post(SearchGetGeocodingBatchParameters)

A API Get Geocoding Batch é uma solicitação de POST HTTP que envia lotes de até 100 consultas para a Geocoding API em uma única solicitação.

Enviar solicitação de lote síncrona

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

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

Corpo POST para solicitação de lote

Para enviar as consultas de geocodificação você usará uma solicitação de onde o corpo da solicitação conterá a matriz em formato e o cabeçalho será definido como . Aqui está um corpo de solicitação de exemplo contendo 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 URIgeocodificação suportados.

O lote deve conter pelo menos 1 consulta.

Modelo de resposta em lote

A resposta em lote contém um componente summary que indica os totalRequests que faziam parte da solicitação de lote original e successfulRequests ou seja, consultas que foram executadas com êxito. A resposta em lote também inclui uma matriz 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 de lote. Cada item é de um dos seguintes tipos:

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

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

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

Parâmetros

options
SearchGetGeocodingBatchParameters

Devoluções

StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>