GetGeocodingBatch interface
Methoden
| post(Search |
Die Synchrone Batchanforderung übermittelnDie synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt. POST-Text für BatchanforderungUm die Geocodierung Abfragen zu senden, verwenden Sie eine Ein Geocodierungsobjekt batchItem-Objekt kann alle unterstützten GeocodierungsparameterURI-Parameterakzeptieren. Der Batch sollte mindestens 1 Abfrage enthalten. BatchantwortmodellDie Batchantwort enthält eine
|
Details zur Methode
post(SearchGetGeocodingBatchParameters)
Die Get Geocoding Batch-API ist eine HTTP-POST-Anforderung, die Batches von bis zu 100 Abfragen an die Geocodierungs--API in einer einzigen Anforderung sendet.
Synchrone Batchanforderung übermitteln
Die synchrone API wird für einfache Batchanforderungen empfohlen. Wenn der Dienst eine Anforderung empfängt, antwortet er, sobald die Batchelemente berechnet werden, und es besteht keine Möglichkeit, die Ergebnisse später abzurufen. Die synchrone API gibt einen Timeoutfehler (eine 408-Antwort) zurück, wenn die Anforderung länger als 60 Sekunden dauert. Die Anzahl der Batchelemente ist auf 100 für diese API beschränkt.
POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01
POST-Text für Batchanforderung
Um die Geocodierung Abfragen zu senden, verwenden Sie eine POST Anforderung, bei der der Anforderungstext das batchItems Array im json Format enthält und der Content-Type Header auf application/jsonfestgelegt wird. Hier sehen Sie einen Beispielanforderungstext mit 2 Geocodierung Abfragen:
{
"batchItems": [
{
"addressLine": "One, Microsoft Way, Redmond, WA 98052",
"top": 2
},
{
"addressLine": "Pike Pl",
"adminDistrict": "WA",
"locality": "Seattle",
"top": 3
}
]
}
Ein Geocodierungsobjekt batchItem-Objekt kann alle unterstützten GeocodierungsparameterURI-Parameterakzeptieren.
Der Batch sollte mindestens 1 Abfrage enthalten.
Batchantwortmodell
Die Batchantwort enthält eine summary Komponente, die die totalRequests angibt, die Teil der ursprünglichen Batchanforderung waren, und successfulRequests d. h. Abfragen, die erfolgreich ausgeführt wurden. Die Batchantwort enthält auch ein batchItems Array, das eine Antwort für jede und jede Abfrage in der Batchanforderung enthält. Die batchItems enthält die Ergebnisse in der genauen Reihenfolge, in der die ursprünglichen Abfragen in der Batchanforderung gesendet wurden. Jedes Element weist einen der folgenden Typen auf:
GeocodingResponse– Wenn die Abfrage erfolgreich abgeschlossen wurde.Error– Wenn die Abfrage fehlgeschlagen ist. Die Antwort enthält in diesem Fall einecodeund einemessage.
function post(options: SearchGetGeocodingBatchParameters): StreamableMethod<SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse>Parameter
Gibt zurück
Azure SDK for JavaScript