GetGeocodingBatch interface

A Get Geocoding Batch API egy OLYAN HTTP-POST-kérés, amely legfeljebb 100 lekérdezést küld a Geokódolási API-nak egyetlen kérelemben.

Szinkronizálási kötegkérelem küldése

A szinkron API ajánlott az egyszerűsített kötegelt kérelmekhez. Amikor a szolgáltatás kérést kap, azonnal válaszol a kötegelemek kiszámításakor, és nem lesz lehetőség az eredmények későbbi lekérésére. A szinkron API időtúllépési hibát (408-ra) ad vissza, ha a kérés 60 másodpercnél tovább tart. A kötegelemek száma az API-hoz legfeljebb 100 .

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

POST törzs a Batch-kérelemhez

A geokódolási lekérdezések küldéséhez egy POST kérést kell használnia, amelyben a kérelem törzse batchItems formátumban tartalmazza a json tömböt, és a Content-Type fejléc application/jsonlesz beállítva. Íme egy mintakérési törzs, amely 2 geokódolási lekérdezést tartalmaz:

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

A batchItem geokódolási objektum a támogatott geokódolásiURI-paraméterekbármelyikét elfogadhatja.

A kötegnek legalább 1 lekérdezést kell tartalmaznia.

Kötegelt válasz modell

A kötegválasz egy summary összetevőt tartalmaz, amely jelzi az eredeti kötegelt kérelem részét képező totalRequests, és successfulRequests, azaz a sikeresen végrehajtott lekérdezéseket. A kötegelt válasz tartalmaz egy batchItems tömböt is, amely a batch-kérelem minden egyes lekérdezésére választ tartalmaz. A batchItems pontosan ugyanabban a sorrendben tartalmazza az eredményeket, mint az eredeti lekérdezéseket a kötegelt kérelemben. Minden elem a következő típusok egyikét tartalmazza:

• GeocodingResponse – Ha a lekérdezés sikeresen befejeződött.

• Error – Ha a lekérdezés sikertelen volt. A válasz ebben az esetben egy code és egy message tartalmaz.

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

Paraméterek

Válaszok