SearchGetGeocodingBatchDefaultResponse interface

Pacchetto:

@azure-rest/maps-search

API Batch di geocodifica

si applica a: vedere i livelli di prezzi.

L'API Batch di geocodifica invia batch di query a 'API geocodifica usando solo una singola chiamata API. L'API consente al chiamante di eseguire il batch fino a 100 query.

Inviare una richiesta batch sincrona

L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.

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

Corpo POST per la richiesta batch

Per inviare la geocodifica query, si userà una richiesta di POST in cui il corpo della richiesta conterrà la matrice batchItems in formato json e l'intestazione Content-Type verrà impostata su application/json. Ecco un corpo di richiesta di esempio contenente 2 query di geocodifica:

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

Un oggetto geocodifica batchItem può accettare uno qualsiasi dei parametri URI geocodifica supportati.

Il batch deve contenere almeno 1 query.

Modello di risposta batch

La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:

• GeocodingResponse: se la query è stata completata correttamente.

• Error: se la query non è riuscita. La risposta conterrà un code e un message in questo caso.

Extends

HttpResponse

Proprietà

body
status

Proprietà ereditate

headers	Intestazioni di risposta HTTP.
request	Richiesta che ha generato questa risposta.

Dettagli proprietà

body

body: ErrorResponseOutput

Valore della proprietà

ErrorResponseOutput

status

status: string

Valore della proprietà

string

Dettagli proprietà ereditate

headers

Intestazioni di risposta HTTP.

headers: RawHttpHeaders

Valore della proprietà

RawHttpHeaders

Ereditato da HttpResponse.headers

request

Richiesta che ha generato questa risposta.

request: PipelineRequest

Valore della proprietà

PipelineRequest

Ereditato da HttpResponse.request