SearchGetGeocodingBatch200Response interface

Paquet:

@azure-rest/maps-search

L’API Get Geocoding Batch est une requête http POST qui envoie des lots allant jusqu’à 100 requêtes à l’API de géocodage dans une seule requête.

Envoyer une demande de traitement par lots synchrone

L’API synchrone est recommandée pour les requêtes par lots légères. Lorsque le service reçoit une demande, il répond dès que les éléments de lot sont calculés et il n’y aura aucune possibilité de récupérer les résultats ultérieurement. L’API synchrone retourne une erreur de délai d’expiration (réponse 408) si la requête prend plus de 60 secondes. Le nombre d’éléments de lot est limité à 100 pour cette API.

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

Corps POST pour la requête Batch

Pour envoyer le géocodage requêtes, vous utiliserez une requête POST où le corps de la requête contiendra le tableau batchItems au format json et l’en-tête Content-Type sera défini sur application/json. Voici un exemple de corps de requête contenant 2 géocodage requêtes :

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

Un objet géocodage batchItem peut accepter l’un des paramètres de géocodage pris en charge.

Le lot doit contenir au moins 1 requête.

Modèle de réponse par lot

La réponse par lot contient un composant summary qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequests c’est-à-dire les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un tableau batchItems qui contient une réponse pour chaque requête dans la requête de lot. Les batchItems contiennent les résultats dans le même ordre que les requêtes d’origine ont été envoyées dans la requête de lot. Chaque élément est de l’un des types suivants :

• GeocodingResponse : si la requête s’est terminée correctement.

• Error : si la requête a échoué. La réponse contient une code et une message dans ce cas.

Extends

HttpResponse

Propriétés

body
status

Propriétés héritées

headers	En-têtes de réponse HTTP.
request	Demande qui a généré cette réponse.

Détails de la propriété

body

body: GeocodingBatchResponseOutput

Valeur de propriété

GeocodingBatchResponseOutput

status

status: "200"

Valeur de propriété

"200"

Détails de la propriété héritée

headers

En-têtes de réponse HTTP.

headers: RawHttpHeaders

Valeur de propriété

RawHttpHeaders

héritée de HttpResponse.headers

request

Demande qui a généré cette réponse.

request: PipelineRequest

Valeur de propriété

PipelineRequest

héritée de HttpResponse.request