Search - Get Search Address Reverse Batch

Référence

Service:: Maps

API Version:: 1.0

Utilisez pour envoyer un lot de requêtes à l’API d’adresse inversée Recherche dans une requête asynchrone unique.

L’API Get Search Address Reverse Batch est une requête HTTP GET qui envoie des lots de requêtes à Recherche’API d’adresse inversée dans un seul appel d’API asynchrone. Vous pouvez appeler Get Search Address Reverse Batch l’API pour s’exécuter de manière asynchrone (asynchrone) ou synchrone (synchronisation). L’API asynchrone permet à l’appelant de traiter par lot jusqu’à 10 000 requêtes et de synchroniser l’API jusqu’à 100 requêtes.

Envoyer une demande de lot synchrone

L’API synchrone est recommandée pour les demandes par lots légères. Lorsque le service reçoit une requête, il répond dès que les éléments de lot sont calculés et qu’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/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Envoyer une demande de lot asynchrone

L’API asynchrone est appropriée pour traiter de gros volumes de demandes de recherche relativement complexes

Il permet la récupération des résultats dans un appel distinct (plusieurs téléchargements sont possibles).
L’API asynchrone est optimisée pour la fiabilité et n’est pas censée s’exécuter dans un délai d’expiration.
Le nombre d’éléments de lot est limité à 10 000 pour cette API.

Lorsque vous effectuez une demande à l’aide d’une requête asynchrone, par défaut, le service retourne un code de réponse 202 le long d’une URL de redirection dans le champ Emplacement de l’en-tête de réponse. Cette URL doit être vérifiée régulièrement jusqu’à ce que les données de réponse ou les informations d’erreur soient disponibles. Les réponses asynchrones sont stockées pendant 14 jours. L’URL de redirection retourne une réponse 404 si elle est utilisée après la période d’expiration.

Notez que la demande par lots asynchrone est une opération de longue durée. Voici une séquence classique d’opérations :

Le client envoie une demande d’Recherche Address Reverse Batch POST à Azure Maps.

POST https://atlas.microsoft.com/search/address/reverse/batch/json?api-version=1.0&subscription-key={subscription-key}

Le serveur répond avec l’un des éléments suivants :

HTTP 202 Accepted : la demande par lots a été acceptée.

HTTP Error : une erreur s’est produite lors du traitement de votre demande Batch. Il peut s’agir d’un 400 Bad Request ou d’un autre Error code status.
Si la demande de lot a été acceptée avec succès, l’en-tête Location de la réponse contient l’URL pour télécharger les résultats de la demande de lot. Cet URI status se présente comme suit :

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Le client émet une GET demande sur l’URL de téléchargement obtenue à l’étape 3 pour télécharger les résultats du lot.

Corps POST pour la demande par lot

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

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Une requête inverse d’adresse de recherche dans un lot n’est qu’une URL partielle sans le protocole, l’URL de base, le chemin, la version de l’API et la clé d’abonnement. Il peut accepter n’importe quel paramètre d’URIinverse d’adresse de recherche pris en charge. Les valeurs de chaîne de la requête inverse d’adresse de recherche doivent être correctement placées dans un échappement (par exemple, « caractère doit être placé dans une séquence d’échappement avec \ ) et elles doivent également être correctement codées sur l’URL.

L’API asynchrone permet à l’appelant de traiter par lot jusqu’à 10 000 requêtes et de synchroniser l’API jusqu’à 100 requêtes, et le lot doit contenir au moins 1 requête.

Télécharger les résultats de lot asynchrones

Pour télécharger les résultats du lot asynchrone, vous devez envoyer une GET requête au point de terminaison de téléchargement par lots. Cette URL de téléchargement peut être obtenue à partir de l’en-tête Location d’une demande de lot réussie POST et se présente comme suit :

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Voici la séquence classique d’opérations pour télécharger les résultats du lot :

Le client envoie une GET requête à l’aide de l’URL de téléchargement.
Le serveur répond avec l’un des éléments suivants :

HTTP 202 Accepted : la demande par lots a été acceptée, mais elle est toujours en cours de traitement. Réessayez dans un certain temps.

HTTP 200 OK - Requête par lots traitée avec succès. Le corps de la réponse contient tous les résultats du lot.

Modèle de réponse par lot

Le contenu de données retourné est similaire pour les demandes asynchrones et de synchronisation. Lors du téléchargement des résultats d’une demande de lot asynchrone, si le traitement du lot est terminé, le corps de la réponse contient la réponse par lot. Cette réponse de lot contient un summary composant qui indique les totalRequests qui faisaient partie de la demande de lot d’origine et successfulRequestsc’est-à-dire 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 de la demande de lot. batchItems contient les résultats exactement dans l’ordre que les requêtes d’origine ont été envoyées dans la demande de lot. Chaque élément dans batchItems contient statusCode des champs et response . Chaque response dans batchItems est de l’un des types suivants :

SearchAddressReverseResponse - Si la requête s’est terminée avec succès.
Error - Si la requête a échoué. La réponse contiendra un code et un message dans ce cas.

Voici un exemple de réponse par lot avec 2 résultats réussis et 1 échec :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

GET https://atlas.microsoft.com/search/address/reverse/batch/{format}?api-version=1.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	string	ID de lot pour l’interrogation de l’opération.
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 quel compte est destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. 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 Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	ReverseSearchAddressBatchProcessResult	Ok
202 Accepted		Pris en charge uniquement pour la requête asynchrone. Demande acceptée : la demande a été acceptée pour traitement. Utilisez l’URL de l’en-tête d’emplacement pour réessayer ou accéder aux résultats. Headers Location: string
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Nom

Type

Description

200 OK

ReverseSearchAddressBatchProcessResult

202 Accepted

Pris en charge uniquement pour la requête asynchrone. Demande acceptée : la demande a été acceptée pour traitement. Utilisez l’URL de l’en-tête d’emplacement pour réessayer ou accéder aux résultats.

Headers

Location: string

Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 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 à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. 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 pour Azure Maps API REST.

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 .
Authorization URL est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques.
Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou 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 Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, notre recommandation est d’utiliser l’approche des applications clientes confidentielles pour accéder à Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
In: query

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 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 de grain 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, notre recommandation est 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 SAP.

Type: apiKey
In: header

Exemples

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/reverse/batch/11111111-2222-3333-4444-555555555555?api-version=1.0

Sample Response

Status code:: 200

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "7",
              "routeNumbers": [],
              "streetName": "Avenue Anatole France",
              "streetNameAndNumber": "7 Avenue Anatole France",
              "countryCode": "FR",
              "countrySubdivisionCode": "Île-de-France",
              "countrySecondarySubdivision": "Paris",
              "municipality": "Paris",
              "postalCode": "75007",
              "municipalitySubdivision": "7ème Arrondissement",
              "country": "France",
              "countryCodeISO3": "FRA",
              "freeformAddress": "7 Avenue Anatole France, Paris, 75007",
              "boundingBox": {
                "northEast": "48.858321,2.295167",
                "southWest": "48.858136,2.295027",
                "entity": "position"
              }
            },
            "position": "48.858231,2.295089"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 8,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "routeNumbers": [],
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "municipality": "Redmond",
              "postalCode": "98052",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "Redmond, WA 98052",
              "boundingBox": {
                "northEast": "47.639765,-122.128661",
                "southWest": "47.639502,-122.129456",
                "entity": "position"
              },
              "countrySubdivisionName": "Washington"
            },
            "position": "47.639687,-122.128677"
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "queryTime": 19,
          "numResults": 1
        },
        "addresses": [
          {
            "address": {
              "streetNumber": "410",
              "routeNumbers": [],
              "streetName": "Thomas Street",
              "streetNameAndNumber": "410 Thomas Street",
              "countryCode": "US",
              "countrySubdivisionCode": "WA",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "municipality": "Seattle",
              "postalCode": "98109",
              "municipalitySubdivision": "Seattle, Lower Queen Anne",
              "country": "United States",
              "countryCodeISO3": "USA",
              "freeformAddress": "410 Thomas Street, Seattle, WA 98109",
              "boundingBox": {
                "northEast": "47.620954,-122.347601",
                "southWest": "47.620944,-122.348498",
                "entity": "position"
              },
              "extendedPostalCode": "981094621",
              "countrySubdivisionName": "Washington"
            },
            "position": "47.620945,-122.348175"
          }
        ]
      }
    }
  ]
}

Status code:: 202

Définitions

Nom	Description
Address	Adresse du résultat
AddressRanges	Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.
BoundingBox	La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.
BoundingBoxCompassNotation	Zone englobante de l’emplacement.
Brand	Marque associée au POI
Classification	Classification du POINT d’identification retourné
ClassificationName	Nom de la classification
DataSources	Section facultative. ID de référence à utiliser avec l’API Get Recherche Polygon.
Entity	Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.
EntryPoint	Point d’entrée du POI retourné.
EntryPointType	Type de point d’entrée. La valeur peut être main ou mineure.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GeographicEntityType	Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.
Geometry	Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.
LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
MatchType	Types de correspondance pour une opération de recherche d’adresses inversées.
OperatingHours	Heures d’ouverture d’un point d’intérêt pour un point d’intérêt.
OperatingHoursTime	Représente une date et une heure
OperatingHoursTimeRange	Intervalle de temps ouvert pour un jour
PointOfInterest	Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications.
PointOfInterestCategorySet	Catégorie POI
QueryType	Type de requête retourné : NEARBY ou NON_NEAR.
Response	Résultat de la requête. SearchAddressResult si la requête s’est terminée correctement, ErrorResponse sinon.
ReverseSearchAddressBatchItem	Élément retourné par Recherche appel de service Address Reverse Batch.
ReverseSearchAddressBatchProcessResult	Cet objet est retourné à partir d’un appel de service Recherche Address Reverse Batch réussi.
SearchAddressResultItem	Objet Result pour une réponse d’API Recherche.
SearchAddressResultType	Valeurs possibles : POI Rue Geography Adresse exacte Plage d’adresses Croisement
SearchSummary	Objet summary pour une réponse d’API Recherche.
Summary	Résumé des résultats de la demande de lot

Address

Adresse du résultat

Nom	Type	Description
boundingBox	BoundingBoxCompassNotation	Zone englobante de l’emplacement.
buildingNumber	string	Numéro d’immeuble dans la rue. DEPRECATED, utilisez plutôt streetNumber.
country	string	nom du pays/de la région
countryCode	string	Pays (Remarque : il s’agit d’un code à deux lettres, et non d’un nom de pays/région.)
countryCodeISO3	string	Code de pays ISO alpha-3
countrySecondarySubdivision	string	County
countrySubdivision	string	State or Province
countrySubdivisionCode	string	`countrySubdivisionCode` préfixé par `countryCode` ( countryCode-countrySubdivisionCode ) et le trait d’union forme le code ISO 3166-2. Exemples : TX pour le Texas, SCT pour l’Écosse et ON pour l’Ontario.
countrySubdivisionName	string	Nom complet d’un premier niveau de hiérarchie administrative pays/région. Ce champ apparaît uniquement dans le cas où countrySubdivision est présenté sous une forme abrégée. Pris en charge uniquement pour les États-Unis, le Canada et le Royaume-Uni.
countryTertiarySubdivision	string	Zone nommée
crossStreet	string	Nom de la rue traversée.
extendedPostalCode	string	Code postal étendu (la disponibilité dépend de la région).
freeformAddress	string	Ligne d’adresse mise en forme selon les règles de mise en forme du pays/région d’origine d’un Result, ou dans le cas d’un pays/région, son nom complet de pays/région.
localName	string	Composant d’adresse qui représente le nom d’une zone géographique ou d’une localité qui regroupe plusieurs objets adressables à des fins d’adressage, sans être une unité administrative. Ce champ est utilisé pour générer la `freeformAddress` propriété. `localName` représente la municipalité postale. Selon l’emplacement, `localName` est le nom communément connu d’une ville ou d’une ville. Pour le nom communément connu d’une ville ou d’une ville, utilisez `localName` au lieu de `municipality`.
municipality	string	Ville/ Ville Remarque : `municipality` représente la municipalité résidentielle. Selon l’emplacement, la `municipality` valeur peut différer du nom communément connu d’une ville ou d’une ville. Pour le nom communément connu de la ville ou de la ville, il est suggéré d’utiliser la `localName` valeur à la place de la `municipality` valeur.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Un quartier est une zone géographiquement localisée au sein d’une ville avec des caractéristiques distinctives et des interactions sociales entre les habitants.
postalCode	string	Postal Code / Zip Code
routeNumbers	string[]	Codes utilisés pour identifier sans ambiguïté la rue
street	string	Nom de la rue. DEPRECATED, utilisez streetName à la place.
streetName	string	Nom de la rue.
streetNameAndNumber	string	Nom et numéro de la rue.
streetNumber	string	Numéro d’immeuble dans la rue.

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.

Nom	Type	Description
from	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
rangeLeft	string	Plage d’adresses sur le côté gauche de la rue.
rangeRight	string	Plage d’adresses sur le côté droit de la rue.
to	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

BoundingBox

La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

Nom	Type	Description
btmRightPoint	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
topLeftPoint	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

BoundingBoxCompassNotation

Zone englobante de l’emplacement.

Nom	Type	Description
entity	Entity	Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.
northEast	string	Latitude nord-est, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules
southWest	string	Latitude sud-ouest, coordonnée de longitude du cadre englobant sous forme de flotteurs séparés par des virgules

Brand

Marque associée au POI

Nom	Type	Description
name	string	Nom de la marque

Classification

Classification du POINT d’identification retourné

Nom	Type	Description
code	string	Propriété code
names	ClassificationName[]	Tableau de noms

ClassificationName

Nom de la classification

Nom	Type	Description
name	string	Nom de la propriété
nameLocale	string	Propriété Name Locale

DataSources

Section facultative. ID de référence à utiliser avec l’API Get Recherche Polygon.

Nom	Type	Description
geometry	Geometry	Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.

Entity

Source de type d’entité du cadre englobant. Pour le géocodage inverse, cette valeur est toujours égale à la position.

Nom	Type	Description
position	string	Entité de position

EntryPoint

Point d’entrée du POI retourné.

Nom	Type	Description
position	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
type	EntryPointType	Type de point d’entrée. La valeur peut être main ou mineure.

EntryPointType

Type de point d’entrée. La valeur peut être main ou mineure.

Nom	Type	Description
main	string
minor	string

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 d’erreur.

GeographicEntityType

Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.

Nom	Type	Description
Country	string	nom du pays/de la région
CountrySecondarySubdivision	string	County
CountrySubdivision	string	State or Province
CountryTertiarySubdivision	string	Zone nommée
Municipality	string	Ville/ Ville
MunicipalitySubdivision	string	Sub / Super City
Neighbourhood	string	Quartier
PostalCodeArea	string	Postal Code / Zip Code

Geometry

Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.

Nom	Type	Description
id	string	Passez ce paramètre en tant que geometryId à l’API Get Recherche Polygon pour extraire des informations géométriques pour ce résultat.

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».

Nom	Type	Description
lat	number	Propriété Latitude
lon	number	Longitude, propriété

MatchType

Types de correspondance pour une opération de recherche d’adresses inversées.

Nom	Type	Description
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

Heures d’ouverture d’un point d’intérêt pour un point d’intérêt.

Nom	Type	Description
mode	string	Valeur utilisée dans la requête : none ou « nextSevenDays »
timeRanges	OperatingHoursTimeRange[]	Liste des intervalles de temps pour les 7 prochains jours

OperatingHoursTime

Représente une date et une heure

Nom	Type	Description
date	string	Représente la date de calendrier actuelle dans le fuseau horaire poI, par exemple « 2019-02-07 ».
hour	integer	Les heures sont au format 24 heures à l’heure locale d’un POINT d’identification ; les valeurs possibles sont de 0 à 23.
minute	integer	Les minutes sont à l’heure locale d’un POINT d’identification ; les valeurs possibles sont comprises entre 0 et 59.

OperatingHoursTimeRange

Intervalle de temps ouvert pour un jour

Nom	Type	Description
endTime	OperatingHoursTime	Point dans la plage de 7 jours suivant lorsqu’un POI donné est en cours de fermeture, ou le début de la plage s’il a été fermé avant la plage.
startTime	OperatingHoursTime	Point dans la plage de 7 jours suivante lorsqu’un POI donné est ouvert, ou le début de la plage s’il a été ouvert avant la plage.

PointOfInterest

Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications.

Nom	Type	Description
brands	Brand[]	Tableau de marques. Nom de la marque pour le POI retourné.
categories	string[]	Tableau de catégories
categorySet	PointOfInterestCategorySet[]	Liste des catégories de POI les plus spécifiques
classifications	Classification[]	Tableau de classification
name	string	Nom de la propriété POI
openingHours	OperatingHours	Heures d’ouverture d’un point d’intérêt pour un point d’intérêt.
phone	string	Propriété Numéro de téléphone
url	string	Propriété URL du site web

PointOfInterestCategorySet

Catégorie POI

Nom	Type	Description
id	integer	ID de la catégorie

QueryType

Type de requête retourné : NEARBY ou NON_NEAR.

Nom	Type	Description
NEARBY	string	Recherche a été effectué autour d’une certaine latitude et longitude avec un rayon défini
NON_NEAR	string	Recherche a été effectué globalement, sans biaiser à une certaine latitude et longitude, et aucun rayon défini

Response

Résultat de la requête. SearchAddressResult si la requête s’est terminée correctement, ErrorResponse sinon.

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.
results	SearchAddressResultItem[]	Liste des résultats de l’API Recherche.
summary	SearchSummary	Objet summary pour une réponse d’API Recherche

ReverseSearchAddressBatchItem

Élément retourné par Recherche appel de service Address Reverse Batch.

Nom	Type	Description
response	Response	Résultat de la requête. SearchAddressReverseResponse si la requête s’est terminée avec succès, ErrorResponse sinon.
statusCode	integer	Requête HTTP status code.

ReverseSearchAddressBatchProcessResult

Cet objet est retourné à partir d’un appel de service Recherche Address Reverse Batch réussi.

Nom	Type	Description
batchItems	ReverseSearchAddressBatchItem[]	Tableau contenant les résultats du lot.
summary	Summary	Résumé des résultats de la demande de lot

SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.

Nom	Type	Description
address	Address	Adresse du résultat
addressRanges	AddressRanges	Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.
dataSources	DataSources	Section facultative. Id de géométrie de référence à utiliser avec l’API Get Recherche Polygon.
detourTime	integer	Temps de détour en secondes. Retourné uniquement pour les appels à l’API Recherche Along Route.
dist	number	Distance en ligne droite entre le résultat et l’emplacement géographique en mètres.
entityType	GeographicEntityType	Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.
entryPoints	EntryPoint[]	Tableau de points d’entrée. Ceux-ci décrivent les types d’entrées disponibles à l’emplacement. Le type peut être « main » pour les entrées main comme une porte d’entrée, ou un hall d’entrée, et « mineur », pour les portes latérales et arrière.
id	string	Id, propriété
info	string	Informations sur la source de données d’origine du résultat. Utilisé pour les demandes de support.
matchType	MatchType	Informations sur le type de correspondance. Valeurs possibles : AddressPoint HouseNumberRange Rue
poi	PointOfInterest	Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications.
position	LatLongPairAbbreviated	Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
score	number	Valeur dans un jeu de résultats pour indiquer le score de correspondance relatif entre les résultats. Vous pouvez l’utiliser pour déterminer que le résultat x est deux fois plus susceptible d’être aussi pertinent que le résultat y si la valeur de x est 2x la valeur de y. Les valeurs varient d’une requête à l’autre et sont uniquement destinées à une valeur relative pour un jeu de résultats.
type	SearchAddressResultType	Valeurs possibles : POI Rue Geography Adresse exacte Plage d’adresses Croisement
viewport	BoundingBox	La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage.

SearchAddressResultType

Valeurs possibles :

POI
Rue
Geography
Adresse exacte
Plage d’adresses
Croisement

Nom	Type	Description
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchSummary

Objet summary pour une réponse d’API Recherche.

Nom	Type	Description
fuzzyLevel	integer	Niveau flou maximal requis pour fournir des résultats.
geoBias	LatLongPairAbbreviated	Indication lorsque le moteur de recherche interne a appliqué un biais géospatial pour améliorer le classement des résultats. Dans certaines méthodes, cela peut être affecté en définissant les paramètres lat et lon lorsqu’ils sont disponibles. Dans d’autres cas, elle est purement interne.
limit	integer	Nombre maximal de réponses qui seront retournées
numResults	integer	Nombre de résultats dans la réponse.
offset	integer	Décalage de départ du résultat retourné dans le jeu de résultats complet.
query	string	Paramètre de requête utilisé pour produire ces résultats de recherche.
queryTime	integer	Temps passé à résoudre la requête, en millisecondes.
queryType	QueryType	Type de requête retourné : NEARBY ou NON_NEAR.
totalResults	integer	Nombre total de résultats trouvés.

Summary

Résumé des résultats 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

Search - Get Search Address Reverse Batch

Envoyer une demande de lot synchrone

Envoyer une demande de lot asynchrone

Corps POST pour la demande par lot

Télécharger les résultats de lot asynchrones

Modèle de réponse par lot

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Scopes

subscription-key

SAS Token

Exemples

A Reverse Geocoding Batch API GET call containing 5 Reverse Geocoding API queries

Sample Request

Sample Response

Définitions

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

Response

ReverseSearchAddressBatchItem

ReverseSearchAddressBatchProcessResult

SearchAddressResultItem

SearchAddressResultType

SearchSummary

Summary

Ressources supplémentaires