Sdílet prostřednictvím

GetReverseGeocodingBatch interface

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

Metody

post(SearchGetReverseGeocodingBatchParameters)

Rozhraní API Get Reverse Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do zpětného geokódování api pomocí jednoho 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/reverseGeocode:batch?api-version=2023-06-01

Text POST pro dávkový požadavek

K odeslání zpětného geografického kó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 nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 zpětné geografické kódování dotazů:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

zpětné geografické kódování objekt batchItem může přijmout kterýkoli z podporovaných reverzní geokódováníparametry 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.

Podrobnosti metody

post(SearchGetReverseGeocodingBatchParameters)

Rozhraní API Get Reverse Geocoding Batch je požadavek HTTP POST, který odesílá dávky až 100 dotazů do zpětného geokódování api pomocí jednoho 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/reverseGeocode:batch?api-version=2023-06-01

Text POST pro dávkový požadavek

K odeslání zpětného geografického kó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 nastavena na application/json. Tady je ukázkový text požadavku obsahující 2 zpětné geografické kódování dotazů:

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

zpětné geografické kódování objekt batchItem může přijmout kterýkoli z podporovaných reverzní geokódováníparametry 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.

function post(options: SearchGetReverseGeocodingBatchParameters): StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>

Parametry

options
SearchGetReverseGeocodingBatchParameters

Návraty

StreamableMethod<SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse>