Search - Get Reverse Geocoding Batch

Permet d’envoyer un lot de requêtes à l’API de géocodage inverse en une seule requête.

L’API Get Reverse Geocoding Batch est une requête HTTP POST qui envoie des lots allant jusqu’à 100 requêtes pour géocodage inverse API à l’aide d’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/reverseGeocode:batch?api-version=2023-06-01

Corps POST pour la requête Batch

Pour envoyer le géocodage inverse 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 inverse requêtes :

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

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

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.

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2025-01-01

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

subscription-key

Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "coordinates": [
        -122.138681,
        47.630358
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        47.630358,
        -122.138681
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "Medium",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "name": "Washington",
                  "shortName": "WA"
                },
                {
                  "name": "King County",
                  "shortName": "King Co."
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
              "streetName": "152nd Ave NE",
              "streetNumber": "2267",
              "addressLine": "2267 152nd Ave NE"
            },
            "geocodePoints": [
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.128275,
                    47.639429
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Display",
                  "Route"
                ]
              },
              {
                "geometry": {
                  "type": "Point",
                  "coordinates": [
                    -122.127028,
                    47.638545
                  ]
                },
                "calculationMethod": "Rooftop",
                "usageTypes": [
                  "Route"
                ]
              }
            ]
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.128275,
              47.639429
            ]
          },
          "bbox": [
            -122.1359181505759,
            47.63556628242932,
            -122.1206318494241,
            47.643291717570676
          ]
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "error": {
        "code": "Bad Request",
        "message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
      },
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Définitions

Address

Adresse du résultat

AdminDistricts

Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.

CalculationMethodEnum

Méthode utilisée pour calculer le point de géocodeur.

ConfidenceEnum

Le niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer pour obtenir des informations plus complètes sur la correspondance.

La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et l’emplacement de l’utilisateur, le cas échéant.

CountryRegion

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

FeatureCollectionEnum

Le type d’un objet FeatureCollection doit être FeatureCollection.

FeaturesItem

FeatureTypeEnum

Le type d’une fonctionnalité doit être Feature.

GeocodePoints

Collection de points de géocode qui diffèrent de la façon dont ils ont été calculés et de leur utilisation suggérée.

GeocodingBatchResponse

Cet objet est retourné à partir d’un appel de service Batch de géocodage réussi.

GeocodingBatchResponseItem

GeoJsonPoint

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.

Intersection

Adresse du résultat.

MatchCodesEnum

Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement de la réponse.

Par exemple, un emplacement géocodé avec des codes de correspondance de Good et de Ambiguous signifie que plusieurs emplacements de géocode ont été trouvés pour les informations d’emplacement et que le service de géocode n’a pas effectué de recherche dans la hiérarchie pour trouver une correspondance.

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’un emplacement de géocode n’a pas pu être trouvé qui correspond à toutes les informations d’emplacement fournies, de sorte que le service géocode devait rechercher dans la hiérarchie et trouver plusieurs correspondances à ce niveau. Un exemple de résultat Ambiguous et UpHierarchy est le cas lorsque vous fournissez des informations d’adresse complètes, mais que le service de géocode ne peut pas localiser une correspondance pour l’adresse postale et retourne plutôt des informations pour plusieurs valeurs RoadBlock.

Les valeurs possibles sont les suivantes :

Good: l’emplacement n’a qu’une seule correspondance ou toutes les correspondances retournées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York retourne plusieurs bonnes correspondances.

Ambiguous: l’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse de rue 128 Main St., la réponse peut retourner deux emplacements pour 128 North Main St. et 128 South Main St. car il n’y a pas suffisamment d’informations pour déterminer quelle option choisir.

UpHierarchy: l’emplacement représente un déplacement vers le haut de la hiérarchie géographique. Cela se produit lorsqu’une correspondance pour la demande d’emplacement n’a pas été trouvée. Par conséquent, un résultat moins précis est retourné. Par exemple, si une correspondance pour l’adresse demandée est introuvable, un code de correspondance de UpHierarchy avec un type d’entité RoadBlock peut être retourné.

Properties

ResultTypeEnum

Spécifiez les types d’entités souhaités dans la réponse. Seuls les types que vous spécifiez sont retournés. Si le point ne peut pas être mappé aux types d’entités que vous spécifiez, aucune information d’emplacement n’est retournée dans la réponse. La valeur par défaut est toutes les entités possibles. Liste séparée par des virgules des types d’entités sélectionnés dans les options suivantes.

• Adresse
• Quartier
• Remplissage
• Code postal1
• AdminDivision1
• AdminDivision2
• Pays/Région

Ces types d’entités sont classés de l’entité la plus spécifique à l’entité la moins spécifique. Lorsque des entités de plusieurs types d’entités sont trouvées, seule l’entité la plus spécifique est retournée. Par exemple, si vous spécifiez Address et AdminDistrict1 comme types d’entités et entités ont été trouvés pour les deux types, seules les informations d’entité Address sont retournées dans la réponse.

ReverseGeocodingBatchRequestBody

Liste des requêtes/requêtes de géocodage inversées à traiter. La liste peut contenir un maximum de 100 requêtes et doit contenir au moins 1 requête.

ReverseGeocodingBatchRequestItem

Objet Batch Query

Summary

Résumé de la demande de traitement par lots

UsageTypeEnum

Meilleure utilisation pour le point de géocode. Chaque point de géocode est défini comme un point Route, un point Display ou les deux. Utilisez Route points si vous créez un itinéraire vers l’emplacement. Utilisez Display points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un point de Route peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un point de Display peut être un point qui spécifie le centre du parc.