Search - Get Reverse Geocoding Batch

Référence

Service:: Maps

Version d'API:: 2023-06-01

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 de jusqu’à 100 requêtes à l’API de géocodage inverse à l’aide d’une seule requête.

Envoyer une demande de lot synchrone

L’API synchrone est recommandée pour les demandes de 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’est plus possible 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 demande 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 demande de lot

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

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

Un objet batchItem de géocodage inverse peut accepter l’un des paramètres d’URI de géocodage inverse 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 summary composant qui indique qui totalRequests faisait partie de la demande de lot d’origine, c’est-à-dire successfulRequests les requêtes qui ont été exécutées avec succès. La réponse par lot inclut également un batchItems tableau qui contient une réponse pour chaque requête dans la demande de lot. Contient batchItems les résultats exactement dans le même ordre que celui que les requêtes d’origine ont été envoyées dans la demande 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 un code et un message dans ce cas.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Numéro de version de l’API Azure Maps.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser la sécurité Azure AD dans Azure Maps, consultez les articles suivants pour obtenir des conseils.
Accept-Language		string	Langue dans laquelle les résultats de la recherche doivent être retournés. Pour plus d’informations, consultez Langues prises en charge .

Nom

Obligatoire

Type

Description

x-ms-client-id

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser la sécurité Azure AD dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Accept-Language

string

Langue dans laquelle les résultats de la recherche doivent être retournés.

Pour plus d’informations, consultez Langues prises en charge .

Corps de la demande

Nom	Type	Description
batchItems	ReverseGeocodingBatchRequestItem[]	Liste des requêtes à traiter.

Réponses

Nom	Type	Description
200 OK	GeocodingBatchResponse	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 2.0 . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure , 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 Ou sous-ressources Azure Maps. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations aux API REST Azure Maps.

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

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion maps.
est Authorization URL spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
Pour plus d’informations sur la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.

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

Étendues

Nom	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les sdk Azure ou les API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, celles-ci peuvent actuellement être traitées comme des clés principales du 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 Répertorier les SAP sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou 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 à la ou les régions d’utilisation du 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 Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.

Type: apiKey
Dans: header

Exemples

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Exemple de requête

HTTP

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

{
  "batchItems": [
    {
      "coordinates": [
        -122.128275,
        47.639429
      ],
      "resultTypes": [
        "Address",
        "PopulatedPlace"
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "coordinates": [
        -122.341979399674,
        47.6095253501216
      ],
      "optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "properties": {
            "type": "Address",
            "confidence": "High",
            "matchCodes": [
              "Good"
            ],
            "address": {
              "locality": "Redmond",
              "adminDistricts": [
                {
                  "shortName": "WA"
                },
                {
                  "shortName": "King"
                }
              ],
              "countryRegion": {
                "ISO": "US",
                "name": "United States"
              },
              "postalCode": "98052",
              "formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
              "addressLine": "1 Microsoft Way"
            },
            "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": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
      "error": {
        "code": "400 Bad Request",
        "message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
      }
    }
  ]
}

Définitions

Nom	Description
Address	Adresse du résultat
AdminDistricts	Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région.
CalculationMethodEnum	Méthode utilisée pour calculer le point de géocode.
ConfidenceEnum	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 par la façon dont ils ont été calculés et 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 geometry valide `GeoJSON Point` . Pour plus d’informations, consultez 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 les codes de correspondance de `Good` et `Ambiguous` signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocodage n’a pas de hiérarchie de recherche 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éocodage n’a pas pu être trouvé correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouvé plusieurs correspondances à ce niveau. Un exemple de `Ambiguous` résultat et `UpHierarchy` est lorsque vous fournissez des informations d’adresse complètes, mais que le service de géocodage ne peut pas localiser une correspondance pour l’adresse postale et retourne à la place 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 correspondances correctes. `Ambiguous`: L’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse postale 128, rue Main, la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’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, de sorte qu’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 que vous souhaitez 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 parmi les options suivantes. Adresse Voisinage PopulatedPlace Code postal1 AdminDivision1 AdminDivision2 CountryRegion 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é et que des 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/demandes de géocodage inverse à 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 lot
UsageTypeEnum	La meilleure utilisation du point de géocode. Chaque point de géocode est défini en tant que `Route` point, `Display` point ou les deux. Utilisez des `Route` points si vous créez un itinéraire vers l’emplacement. Utilisez des `Display` points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un `Route` point peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un `Display` point peut être un point qui spécifie le centre du parc.

Address

Adresse du résultat

Nom	Type	Description
addressLine	string	AddressLine qui inclut le nom et le numéro de rue
adminDistricts	AdminDistricts[]	Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région.
countryRegion	CountryRegion
formattedAddress	string	Propriété d’adresse mise en forme
intersection	Intersection	Adresse du résultat.
locality	string	locality, propriété
neighborhood	string	propriété neighborhood
postalCode	string	Propriété Code postal

AdminDistricts

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

Nom	Type	Description
name	string	Nom du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom complet de l’état, par exemple Washington, Pour adminDistrict[1], il peut s’agir du nom complet du comté
shortName	string	Nom court du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir d’un nom court d’état tel que WA, For adminDistrict[1], il peut s’agir du nom court du comté

CalculationMethodEnum

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

Nom	Type	Description
Interpolation	string	Le point de géocodage a été mis en correspondance avec un point sur une route à l’aide de l’interpolation.
InterpolationOffset	string	Le point de géocodage a été mis en correspondance avec un point sur une route à l’aide de l’interpolation avec un décalage supplémentaire pour décaler le point sur le côté de la rue.
Parcel	string	Le point de géocode a été mis en correspondance au centre d’un colis.
Rooftop	string	Le point de géocode a été mis en correspondance avec le toit d’un bâtiment.

ConfidenceEnum

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.

Nom Type Description

High

Nom	Type	Description
High	string	Si la confiance est définie sur `High`, une ou plusieurs correspondances fortes ont été trouvées. Les correspondances de confiance multiples `High` sont triées par ordre de classement par importance, le cas échéant. Par exemple, les points de repère ont de l’importance, mais pas les adresses. Si une demande inclut un emplacement ou une vue, le classement peut changer de manière appropriée. Par exemple, une requête d’emplacement pour « Paris » retourne « Paris, France » et « Paris, TX » avec `High` confiance. « Paris, France » est toujours classé en premier en raison de l’importance, sauf si un emplacement utilisateur indique que l’utilisateur est dans ou très proche de Paris, TX ou que la vue cartographique indique que l’utilisateur effectue une recherche dans cette zone.
Low	string
Medium	string	Dans certaines situations, la correspondance retournée peut ne pas être au même niveau que les informations fournies dans la demande. Par exemple, une demande peut spécifier des informations d’adresse et le service de géocodage ne peut être en mesure de faire correspondre qu’un code postal. Dans ce cas, si le service de géocodage a la certitude que le code postal correspond aux `Medium` données, la confiance est définie sur et le code de correspondance est défini sur `UpHierarchy` pour spécifier qu’il ne pouvait pas correspondre à toutes les informations et devait effectuer une recherche dans la hiérarchie. Si les informations d’emplacement dans la requête sont ambiguës et qu’il n’existe aucune information supplémentaire pour classer les emplacements (telles que l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), la confiance est définie sur `Medium`. Par exemple, une requête d’emplacement pour « 148th Ave, Bellevue » peut retourner « 148th Ave SE » et « 148th Ave NE » avec `Medium` confiance. Si les informations d’emplacement dans la requête ne fournissent pas suffisamment d’informations pour géocoder un emplacement spécifique, une valeur d’emplacement moins précise peut être retournée et la confiance est définie sur `Medium`. Par exemple, si une adresse est fournie, mais qu’aucune correspondance n’est trouvée pour le numéro de maison, le résultat du géocode avec un type d’entité Roadblock peut être retourné.

string

Si la confiance est définie sur High, une ou plusieurs correspondances fortes ont été trouvées. Les correspondances de confiance multiples High sont triées par ordre de classement par importance, le cas échéant. Par exemple, les points de repère ont de l’importance, mais pas les adresses.

Si une demande inclut un emplacement ou une vue, le classement peut changer de manière appropriée. Par exemple, une requête d’emplacement pour « Paris » retourne « Paris, France » et « Paris, TX » avec High confiance. « Paris, France » est toujours classé en premier en raison de l’importance, sauf si un emplacement utilisateur indique que l’utilisateur est dans ou très proche de Paris, TX ou que la vue cartographique indique que l’utilisateur effectue une recherche dans cette zone.

Low

string

Medium

string

Dans certaines situations, la correspondance retournée peut ne pas être au même niveau que les informations fournies dans la demande. Par exemple, une demande peut spécifier des informations d’adresse et le service de géocodage ne peut être en mesure de faire correspondre qu’un code postal. Dans ce cas, si le service de géocodage a la certitude que le code postal correspond aux Medium données, la confiance est définie sur et le code de correspondance est défini sur UpHierarchy pour spécifier qu’il ne pouvait pas correspondre à toutes les informations et devait effectuer une recherche dans la hiérarchie.

Si les informations d’emplacement dans la requête sont ambiguës et qu’il n’existe aucune information supplémentaire pour classer les emplacements (telles que l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), la confiance est définie sur Medium. Par exemple, une requête d’emplacement pour « 148th Ave, Bellevue » peut retourner « 148th Ave SE » et « 148th Ave NE » avec Medium confiance.

Si les informations d’emplacement dans la requête ne fournissent pas suffisamment d’informations pour géocoder un emplacement spécifique, une valeur d’emplacement moins précise peut être retournée et la confiance est définie sur Medium. Par exemple, si une adresse est fournie, mais qu’aucune correspondance n’est trouvée pour le numéro de maison, le résultat du géocode avec un type d’entité Roadblock peut être retourné.

CountryRegion

Nom	Type	Description
ISO	string	ISO du pays/de la région
name	string	nom du pays/de la région

ErrorAdditionalInfo

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

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

FeatureCollectionEnum

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

Nom	Type	Description
FeatureCollection	string

FeaturesItem

Nom	Type	Description
bbox	number[]	Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, consultez RFC 7946 .
geometry	GeoJsonPoint	Type geometry valide `GeoJSON Point` . Pour plus d’informations, consultez RFC 7946 .
id	string	ID de la fonctionnalité retournée
properties	Properties
type	FeatureTypeEnum	Le type d’une fonctionnalité doit être Feature.

FeatureTypeEnum

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

Nom	Type	Description
Feature	string

GeocodePoints

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

Nom	Type	Description
calculationMethod	CalculationMethodEnum	Méthode utilisée pour calculer le point de géocode.
geometry	GeoJsonPoint	Type geometry valide `GeoJSON Point` . Pour plus d’informations, consultez RFC 7946 .
usageTypes	UsageTypeEnum[]	La meilleure utilisation du point de géocode. Chaque point de géocode est défini en tant que `Route` point, `Display` point ou les deux. Utilisez des `Route` points si vous créez un itinéraire vers l’emplacement. Utilisez des `Display` points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un `Route` point peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un `Display` point peut être un point qui spécifie le centre du parc.

GeocodingBatchResponse

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

Nom	Type	Description
batchItems	GeocodingBatchResponseItem[]	Tableau contenant les résultats du lot.
nextLink	string	est le lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, non ce champ.
summary	Summary	Résumé de la demande de lot

GeocodingBatchResponseItem

Nom	Type	Description
error	ErrorDetail	Détail de l’erreur.
features	FeaturesItem[]
nextLink	string	est le lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, non ce champ.
optionalId	string	id de l’objet batchItem qui serait identique à l’ID dans la demande
type	FeatureCollectionEnum	Le type d’un objet FeatureCollection doit être FeatureCollection.

GeoJsonPoint

Type geometry valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom	Type	Description
bbox	number[]	Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, consultez RFC 7946 .
coordinates	number[]	Un `Position` est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Elevation est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .
type	string: Point	Spécifie le type `GeoJSON`. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

Intersection

Adresse du résultat.

Nom	Type	Description
baseStreet	string	Rue principale de l’emplacement.
displayName	string	Nom complet de l’intersection.
intersectionType	string	Type d’intersection.
secondaryStreet1	string	La première rue qui se croise.
secondaryStreet2	string	Le cas échéant, la deuxième rue qui se croise.

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 les codes de correspondance de Good et Ambiguous signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocodage n’a pas de hiérarchie de recherche 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éocodage n’a pas pu être trouvé correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouvé plusieurs correspondances à ce niveau. Un exemple de Ambiguous résultat et UpHierarchy est lorsque vous fournissez des informations d’adresse complètes, mais que le service de géocodage ne peut pas localiser une correspondance pour l’adresse postale et retourne à la place 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 correspondances correctes.

Ambiguous: L’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse postale 128, rue Main, la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’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, de sorte qu’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é.

Nom	Type	Description
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nom	Type	Description
address	Address	Adresse du résultat
confidence	ConfidenceEnum	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.
geocodePoints	GeocodePoints[]	Collection de points de géocode qui diffèrent par la façon dont ils ont été calculés et leur utilisation suggérée.
matchCodes	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 les codes de correspondance de `Good` et `Ambiguous` signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocodage n’a pas de hiérarchie de recherche 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éocodage n’a pas pu être trouvé correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouvé plusieurs correspondances à ce niveau. Un exemple de `Ambiguous` résultat et `UpHierarchy` est lorsque vous fournissez des informations d’adresse complètes, mais que le service de géocodage ne peut pas localiser une correspondance pour l’adresse postale et retourne à la place 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 correspondances correctes. `Ambiguous`: L’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse postale 128, rue Main, la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’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, de sorte qu’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é.
type	string	Valeurs possibles : Adresse Barrage routier RoadIntersection Voisinage PopulatedPlace Code postal1 AdminDivision1 AdminDivision2 CountryRegion

ResultTypeEnum

Spécifiez les types d’entités que vous souhaitez 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 parmi les options suivantes.

Adresse
Voisinage
PopulatedPlace
Code postal1
AdminDivision1
AdminDivision2
CountryRegion

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é et que des entités ont été trouvés pour les deux types, seules les informations d’entité Address sont retournées dans la réponse.

Nom	Type	Description
Address	string
AdminDivision1	string
AdminDivision2	string
CountryRegion	string
Neighborhood	string
PopulatedPlace	string
Postcode1	string

ReverseGeocodingBatchRequestBody

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

Nom	Type	Description
batchItems	ReverseGeocodingBatchRequestItem[]	Liste des requêtes à traiter.

ReverseGeocodingBatchRequestItem

Objet Batch Query

Nom	Type	Description
coordinates	number[]	Coordonnées de l’emplacement que vous souhaitez inverser le géocode. Exemple : [lon,lat]
optionalId	string	ID de la requête qui s’affiche dans batchItem correspondant
resultTypes	ResultTypeEnum[]	Spécifiez les types d’entités que vous souhaitez 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 parmi les options suivantes. Adresse Voisinage PopulatedPlace Code postal1 AdminDivision1 AdminDivision2 CountryRegion 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é et que des entités ont été trouvés pour les deux types, seules les informations d’entité Address sont retournées dans la réponse.
view	string	Chaîne qui spécifie un code de région/pays ISO 3166-1 Alpha-2. Cela modifie les frontières et les étiquettes géopolitiques contestées pour qu’elles s’alignent sur la région utilisateur spécifiée.

Summary

Résumé de la demande de lot

Nom	Type	Description
successfulRequests	integer	Nombre de demandes réussies dans le lot
totalRequests	integer	Nombre total de demandes dans le lot

UsageTypeEnum

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

Nom	Type	Description
Display	string
Route	string

Partager via

Search - Get Reverse Geocoding Batch

Envoyer une demande de lot synchrone

Corps POST pour la demande de lot

Modèle de réponse par lot

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AADToken

Étendues

subscription-key

SAS Token

Exemples

A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries

Exemple de requête

Exemple de réponse

Définitions

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingBatchResponse

GeocodingBatchResponseItem

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

ResultTypeEnum

ReverseGeocodingBatchRequestBody

ReverseGeocodingBatchRequestItem

Summary

UsageTypeEnum

Ressources supplémentaires