GetGeocodingBatch interface

Get Geocoding Batch-API:et är en HTTP-POST begäran som skickar batchar med upp till 100 frågor till Geocoding API i en enda begäran.

Skicka synkron Batch-begäran

Synkront API rekommenderas för enkla batchbegäranden. När tjänsten tar emot en begäran svarar den så snart batchobjekten har beräknats och det finns ingen möjlighet att hämta resultatet senare. Synkront API returnerar ett timeout-fel (ett 408-svar) om begäran tar längre tid än 60 sekunder. Antalet batchobjekt är begränsat till 100 för det här API:et.

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

POST-brödtext för Batch-begäran

Om du vill skicka geokodning frågor använder du en POST begäran där begärandetexten innehåller batchItems matrisen i json format och Content-Type-huvudet anges till application/json. Här är ett exempel på begärandetext som innehåller 2 geokodning frågor:

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

Ett batchItem-objekt kan acceptera någon av de geokodningsparametrar som stödsURI-parametrar.

Batchen ska innehålla minst 1 fråga.

Batch-svarsmodell

Batchsvaret innehåller en summary komponent som anger totalRequests som ingick i den ursprungliga batchbegäran och successfulRequests dvs. frågor som har körts korrekt. Batch-svaret innehåller också en batchItems matris som innehåller ett svar för varje fråga i batchbegäran. batchItems innehåller resultatet i exakt samma ordning som de ursprungliga frågorna skickades i batchbegäran. Varje objekt är av någon av följande typer:

• GeocodingResponse – Om frågan har slutförts.

• Error – om frågan misslyckades. Svaret innehåller en code och en message i det här fallet.

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

Parametrar

Returer