SearchGetReverseGeocodingBatchDefaultResponse interface
Reverse Geocoding Batch API
Gilt für: Siehe Preise Stufen.
Die Reverse Geocoding Batch-API sendet Batches von Abfragen an Reverse Geocoding API nur mithilfe eines einzelnen API-Aufrufs. Mit der API kann der Aufrufer bis zu 100 Abfragen stapeln.
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/reverseGeocode:batch?api-version=2023-06-01
POST-Text für Batchanforderung
Um die umgekehrte 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 wird auf application/jsonfestgelegt. Hier ist ein Beispielanforderungstext mit 2 umgekehrten Geocodierung Abfragen:
{
"batchItems": [
{
"coordinates": [-122.128275, 47.639429],
"resultTypes": ["Address", "PopulatedPlace"]
},
{
"coordinates": [-122.341979399674, 47.6095253501216]
}
]
}
Ein umgekehrte Geocodierung batchItem-Objekt kann jedes der unterstützten umgekehrten 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.
- Extends
Eigenschaften
| body | |
| status |
Geerbte Eigenschaften
| headers | Die HTTP-Antwortheader. |
| request | Die Anforderung, die diese Antwort generiert hat. |
Details zur Eigenschaft
body
status
status: stringEigenschaftswert
string
Geerbte Eigenschaftsdetails
headers
Die HTTP-Antwortheader.
headers: RawHttpHeadersEigenschaftswert
geerbt von HttpResponse.headers
request
Die Anforderung, die diese Antwort generiert hat.
request: PipelineRequestEigenschaftswert
geerbt von HttpResponse.request
Azure SDK for JavaScript