Sdílet prostřednictvím

SearchGetGeocodingBatchDefaultResponse interface

  • Reference
Balíček:
@azure-rest/maps-search

Rozhraní API Get Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do rozhraní API geokódování v jednom požadavku.

Odeslat synchronní dávkový požadavek

Synchronní rozhraní API se doporučuje pro zjednodušené dávkové požadavky. Když služba obdrží požadavek, odpoví hned po výpočtu dávkových položek a později nebude možné načíst výsledky. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet dávkových položek je omezený na 100 pro toto rozhraní API.

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

Text POST pro dávkový požadavek

K odeslání geokódování dotazů použijete požadavek POST, kde text požadavku bude obsahovat pole batchItems ve formátu json a hlavička Content-Type bude nastavená na application/json. Tady je ukázkový text požadavku obsahující 2 geokódování dotazů:

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

Objekt batchItem geokódování může přijmout některý z podporovaných parametrů geografického kódováníidentifikátoru URI.

Dávka by měla obsahovat alespoň 1 dotazu.

Model dávkové odpovědi

Dávková odpověď obsahuje komponentu summary, která označuje totalRequests, které byly součástí původní dávkové žádosti a successfulRequests tj. dotazy, které byly úspěšně provedeny. Dávková odpověď obsahuje také pole batchItems, které obsahuje odpověď pro každý dotaz v dávkovém požadavku. batchItems bude obsahovat výsledky ve stejném pořadí, v jakém byly původní dotazy odeslány v dávkové žádosti. Každá položka má jeden z následujících typů:

  • GeocodingResponse – Pokud se dotaz úspěšně dokončil.

  • Error – Pokud dotaz selhal. Odpověď bude obsahovat code a v tomto případě message.

Extends
HttpResponse

Vlastnosti

body
status

Zděděné vlastnosti

headers

Hlavičky odpovědi HTTP.
request

Požadavek, který vygeneroval tuto odpověď.

Podrobnosti vlastnosti

body 

body: ErrorResponseOutput

Hodnota vlastnosti

ErrorResponseOutput

status 

status: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

headers

Hlavičky odpovědi HTTP.

headers: RawHttpHeaders

Hodnota vlastnosti

RawHttpHeaders

zděděno z httpResponse.headers

request

Požadavek, který vygeneroval tuto odpověď.

request: PipelineRequest

Hodnota vlastnosti

PipelineRequest

zděděno z HttpResponse.request