Udostępnij za pośrednictwem

GetGeocodingBatch interface

  • Odwołanie
Pakiet:
@azure-rest/maps-search

Metody

post(SearchGetGeocodingBatchParameters)

Interfejs API Get Geocoding Batch to żądanie POST HTTP, które wysyła partie do 100 zapytań do interfejsu API geokodowania w jednym żądaniu.

Przesyłanie synchronicznego żądania usługi Batch

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

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

Treść POST dla żądania wsadowego

Aby wysłać zapytania geokodowania, użyjesz żądania , w którym treść żądania będzie zawierać tablicę w formacie , a nagłówek zostanie ustawiony na wartość . Oto przykładowa treść żądania zawierająca 2 geokodowanie zapytań:

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

Obiekt geokodowania batchItem może zaakceptować dowolny z obsługiwanych parametrów geokodowania identyfikatora URI.

Partia powinna zawierać co najmniej 1 kwerendy.

Model odpowiedzi wsadowej

Odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequests tj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element jest jednym z następujących typów:

  • GeocodingResponse — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

Szczegóły metody

post(SearchGetGeocodingBatchParameters)

Interfejs API Get Geocoding Batch to żądanie POST HTTP, które wysyła partie do 100 zapytań do interfejsu API geokodowania w jednym żądaniu.

Przesyłanie synchronicznego żądania usługi Batch

Interfejs API synchroniczny jest zalecany w przypadku lekkich żądań wsadowych. Gdy usługa odbierze żądanie, odpowie natychmiast po obliczeniu elementów wsadowych i nie będzie możliwe późniejsze pobranie wyników. Interfejs API synchroniczny zwróci błąd limitu czasu (odpowiedź 408), jeśli żądanie trwa dłużej niż 60 sekund. Liczba elementów wsadowych jest ograniczona do 100 dla tego interfejsu API.

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

Treść POST dla żądania wsadowego

Aby wysłać zapytania geokodowania, użyjesz żądania , w którym treść żądania będzie zawierać tablicę w formacie , a nagłówek zostanie ustawiony na wartość . Oto przykładowa treść żądania zawierająca 2 geokodowanie zapytań:

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

Obiekt geokodowania batchItem może zaakceptować dowolny z obsługiwanych parametrów geokodowania identyfikatora URI.

Partia powinna zawierać co najmniej 1 kwerendy.

Model odpowiedzi wsadowej

Odpowiedź wsadowa zawiera składnik summary wskazujący totalRequests, które były częścią oryginalnego żądania wsadowego i successfulRequests tj. zapytania, które zostały wykonane pomyślnie. Odpowiedź wsadowa zawiera również tablicę batchItems zawierającą odpowiedź dla każdego zapytania w żądaniu wsadowym. batchItems będzie zawierać wyniki w dokładnie takiej samej kolejności, w jaki oryginalne zapytania zostały wysłane w żądaniu wsadowym. Każdy element jest jednym z następujących typów:

  • GeocodingResponse — jeśli zapytanie zostało ukończone pomyślnie.

  • Error — jeśli zapytanie nie powiodło się. Odpowiedź będzie zawierać code i message w tym przypadku.

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

Parametry

options
SearchGetGeocodingBatchParameters

Zwraca

StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>