Search - Get Search Address Reverse Batch

Référence

Service:: Maps

Version d'API:: 1.0

Permet d’envoyer un lot de requêtes à l’API 'adresse de recherche inverse 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 à 'API inverse d’adresse de recherche dans un seul appel d’API asynchrone. Vous pouvez appeler Get Search Address Reverse Batch API pour s’exécuter de manière asynchrone (asynchrone) ou synchrone (synchronisation). L’API asynchrone permet à l’appelant de traiter jusqu’à 10 000 requêtes et de synchroniser l’API jusqu’à 100 requêtes.

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/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Envoyer une demande de traitement par lots asynchrone

L’API asynchrone convient au traitement de gros volumes de requêtes 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 requête à 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 de traitement par lots asynchrone est une opération longue. Voici une séquence classique d’opérations :

Le client envoie un lot inverse d’adresse de recherche POST demande à 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’une des options suivantes :

HTTP 202 Accepted : la requête Batch a été acceptée.

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

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

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

Corps POST pour la requête Batch

Pour envoyer l’adresse de recherche requêtes inversées, 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 5 requêtes d’adresse de recherche inverse :

{
    "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 adresse de recherche inversée requête dans un lot n’est qu’une URL partielle sans le protocole, l’URL de base, le chemin d’accès, la version d’API et la clé d’abonnement. Il peut accepter l’un des paramètres d’URI d’adresse de recherche pris en charge. Les valeurs de chaîne dans l’adresse de recherche inverse requête doivent être correctement échappées (par exemple, « caractère doit être échappé avec \ ) et il doit également être correctement codé en URL.

L’API asynchrone permet à l’appelant de traiter 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 de lot asynchrones, vous émettrez une demande de GET sur le 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 traitement par lots réussie POST et ressemble à ce qui 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 demande de GET à l’aide de l’URL de téléchargement .
Le serveur répond avec l’une des options suivantes :

HTTP 202 Accepted : la requête Batch a été acceptée mais est toujours traitée. Réessayez dans un certain temps.

HTTP 200 OK - Requête batch correctement traitée. 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 traitement asynchrone par lot, si le traitement du lot a terminé, le corps de la réponse contient la réponse par lot. Cette réponse par lot contient un composant summary 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 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 de batchItems contient des champs statusCode et response. Chaque response dans batchItems est de l’un des types suivants :

SearchAddressReverseResponse : 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.

Voici un exemple de réponse batch avec 2 réussite et 1 échec résultat :

{
    "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 le compte destiné à l’utilisation 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 de plan de gestion Azure Maps. Pour utiliser la sécurité microsoft Entra ID dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

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

Nom

Type

Description

200 OK

ReverseSearchAddressBatchProcessResult

D’ACCORD

202 Accepted

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

En-têtes

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é à '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.

Remarque

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.
La Authorization URL est 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 de l'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 la 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 provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.

Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: 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 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 GET call containing 5 Reverse Geocoding API queries

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
          }
        ]
      }
    }
  ]
}

Code d’état:: 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 obtenir un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.
BoundingBox	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 de vue retourné
ClassificationName	Nom de la classification
DataSources	Section facultative. ID de référence à utiliser avec l’API Obtenir le polygone de recherche.
Entity	Source de type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.
EntryPoint	Point d’entrée pour le point d’identification du point d’identification retourné.
EntryPointType	Type de point d’entrée. La valeur peut être principale 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ésentez uniquement quand entityType a été demandé et est disponible.
Geometry	Informations sur la forme géométrique du résultat. Présente uniquement si type == Geography.
LatLongPairAbbreviated	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.
MatchType	Types de correspondance pour une opération de recherche d’adresse inversée.
OperatingHours	Heures d’ouverture d’un POI (Points d’intérêt).
OperatingHoursTime	Représente une date et une heure
OperatingHoursTimeRange	Intervalle de temps ouvert pour une journée
PointOfInterest	Détails du poI retourné, y compris les 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é à partir de l’appel de service Batch inverse de l’adresse de recherche.
ReverseSearchAddressBatchProcessResult	Cet objet est retourné à partir d’un appel de service Batch inversé d’adresse de recherche réussi.
SearchAddressResultItem	Objet Result pour une réponse d’API de recherche.
SearchAddressResultType	Un parmi : POI Rue Géographie Adresse exacte Plage d’adresses Croisement
SearchSummary	Objet résumé pour une réponse d’API de recherche.
Summary	Résumé des résultats de la demande de traitement par lots

Address

Object

Adresse du résultat

Nom	Type	Description
boundingBox	BoundingBoxCompassNotation	Zone englobante de l’emplacement.
buildingNumber	string	Numéro de bâtiment sur la rue. DÉCONSEILLÉ, 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 pays ISO alpha-3
countrySecondarySubdivision	string	Comté
countrySubdivision	string	État ou province
countrySubdivisionCode	string	`countrySubdivisionCode` préfixées 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 forme abrégée. Uniquement pris en charge pour les États-Unis, le Canada et le Royaume-Uni.
countryTertiarySubdivision	string	Zone nommée
crossStreet	string	Nom de la rue en cours de traversée.
extendedPostalCode	string	Code postal étendu (la disponibilité dépend de la région).
freeformAddress	string	Ligne d’adresse mise en forme en fonction des règles de mise en forme du pays/de la région d’origine d’un résultat, ou dans le cas d’un pays/région, son nom de pays/région complet.
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 propriété `freeformAddress`. `localName` représente la municipalité postale. Selon l’emplacement, `localName` est le nom couramment connu d’une ville ou d’une ville. Pour le nom couramment 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 valeur `municipality` peut différer du nom couramment connu d’une ville ou d’une ville. Pour le nom couramment connu de la ville ou de la ville, il est suggéré que la valeur `localName` soit utilisée au lieu de la valeur `municipality`.
municipalitySubdivision	string	Sub / Super City
neighbourhood	string	Un quartier est une zone géographiquement localisée au sein d’une ville ou 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. DÉCONSEILLÉ, utilisez streetName à la place.
streetName	string	Nom de la rue.
streetNameAndNumber	string	Nom et numéro de la rue.
streetNumber	string	Numéro de bâtiment sur la rue.

AddressRanges

Object

Décrit la plage d’adresses des deux côtés de la rue pour obtenir 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	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & '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	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.

BoundingBox

Object

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	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.

BoundingBoxCompassNotation

Object

Zone englobante de l’emplacement.

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

Brand

Object

Marque associée au POI

Nom	Type	Description
name	string	Nom de la marque

Classification

Object

Classification du point de vue retourné

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

ClassificationName

Object

Nom de la classification

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

DataSources

Object

Section facultative. ID de référence à utiliser avec l’API Obtenir le polygone de recherche.

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

Entity

Énumération

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

Valeur	Description
position	Position de l’entité

EntryPoint

Object

Point d’entrée pour le point d’identification du point d’identification retourné.

Nom	Type	Description
position	LatLongPairAbbreviated	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.
type	EntryPointType	Type de point d’entrée. La valeur peut être principale ou mineure .

EntryPointType

Énumération

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

Valeur	Description
main
minor

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GeographicEntityType

Énumération

Type d’entité geography. Présentez uniquement quand entityType a été demandé et est disponible.

Valeur	Description
Country	nom du pays/de la région
CountrySecondarySubdivision	Comté
CountrySubdivision	État ou province
CountryTertiarySubdivision	Zone nommée
Municipality	Ville / Ville
MunicipalitySubdivision	Sub / Super City
Neighbourhood	Voisinage
PostalCodeArea	Postal Code / Zip Code

Geometry

Object

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

Nom	Type	Description
id	string	Transmettez ce paramètre en tant que geometryId à l’API Obtenir le polygone de recherche pour extraire des informations géométriques pour ce résultat.

LatLongPairAbbreviated

Object

Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.

Nom	Type	Description
lat	number (double)	Latitude, propriété
lon	number (double)	Longitude, propriété

MatchType

Énumération

Types de correspondance pour une opération de recherche d’adresse inversée.

Valeur	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

Heures d’ouverture d’un POI (Points d’intérêt).

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

OperatingHoursTime

Object

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 dans l’heure locale d’un POI ; les valeurs possibles sont 0 à 23.
minute	integer	Les minutes sont dans l’heure locale d’un POI ; les valeurs possibles sont 0 à 59.

OperatingHoursTimeRange

Object

Intervalle de temps ouvert pour une journée

Nom	Type	Description
endTime	OperatingHoursTime	Point dans la plage de 7 jours suivant lorsqu’un point d’identification de point d’intérêt donné est fermé ou au 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 point d’identification de point d’intérêt donné est ouvert ou au début de la plage s’il a été ouvert avant la plage.

PointOfInterest

Object

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

Nom	Type	Description
brands	Brand[]	Tableaux 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 POI (Points d’intérêt).
phone	string	Propriété numéro de téléphone
url	string	Propriété URL du site web

PointOfInterestCategorySet

Object

Catégorie POI

Nom	Type	Description
id	integer	ID de catégorie

QueryType

Énumération

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

Valeur	Description
NEARBY	La recherche a été effectuée autour d’une certaine latitude et longitude avec un rayon défini
NON_NEAR	La recherche a été effectuée globalement, sans biaiser une certaine latitude et longitude, et aucun rayon défini

Response

Object

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 de recherche.
summary	SearchSummary	Objet summary pour une réponse d’API de recherche

ReverseSearchAddressBatchItem

Object

Élément retourné à partir de l’appel de service Batch inverse de l’adresse de recherche.

Nom	Type	Description
response	Response	Résultat de la requête. SearchAddressReverseResponse si la requête s’est terminée correctement, ErrorResponse sinon.
statusCode	integer	Code d’état de la requête HTTP.

ReverseSearchAddressBatchProcessResult

Object

Cet objet est retourné à partir d’un appel de service Batch inversé d’adresse de recherche 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 traitement par lots

SearchAddressResultItem

Object

Objet Result pour une réponse d’API de 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 obtenir 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 Obtenir un polygone de recherche.
detourTime	integer	Temps de détour en secondes. Retourné uniquement pour les appels à l’API Search Along Route.
dist	number (double)	Distance droite entre le résultat et l’emplacement géographique en mètres.
entityType	GeographicEntityType	Type d’entité geography. Présentez uniquement quand 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 « principal » pour les entrées principales telles qu’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. Un parmi : AddressPoint HouseNumberRange Rue
poi	PointOfInterest	Détails du poI retourné, y compris les informations telles que le nom, le téléphone, l’adresse URL et les classifications.
position	LatLongPairAbbreviated	Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'.
score	number (double)	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 x de résultat est deux fois plus susceptible d’être aussi pertinent que le résultat y si la valeur de x est 2x la valeur y. Les valeurs varient entre les requêtes et ne sont destinées qu’à une valeur relative pour un jeu de résultats.
type	SearchAddressResultType	Un parmi : POI Rue Géographie Adresse exacte Plage d’adresses Croisement
viewport	BoundingBox	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

Énumération

Un parmi :

POI
Rue
Géographie
Adresse exacte
Plage d’adresses
Croisement

Valeur	Description
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchSummary

Object

Objet résumé pour une réponse d’API de recherche.

Nom	Type	Description
fuzzyLevel	integer	Niveau flou maximal requis pour fournir les 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, le cas échéant. Dans d’autres cas, il 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 des résultats retournés 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

Object

Résumé des résultats de la demande de traitement par lots

Nom	Type	Description
successfulRequests	integer	Nombre de requêtes réussies dans le lot
totalRequests	integer	Nombre total de requêtes dans le lot

Partager via

Search - Get Search Address Reverse Batch

Envoyer une demande de traitement par lots synchrone

Envoyer une demande de traitement par lots asynchrone

Corps POST pour la requête Batch

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

Étendues

subscription-key

SAS Token

Exemples

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

Exemple de requête

Exemple de réponse

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