Search - Get Search Address

Service:: Maps

Version d'API:: 1.0

Permet d’obtenir les coordonnées de latitude et de longitude d’une adresse postale dans un format d’entrée non structuré ou de requête.

L’API Get Search Address est une requête HTTP GET retourne les coordonnées de latitude et de longitude lorsqu’elle est passée dans une adresse de rue ou un nom d’emplacement comme critères de recherche.

Dans de nombreux cas, le service de recherche complet peut être trop important, par exemple si vous n’êtes intéressé que par le géocodage traditionnel. Vous pouvez également accéder à la recherche d’adresses exclusivement. Le géocodage est effectué en appuyant sur le point de terminaison de géocode avec uniquement l’adresse ou l’adresse partielle en question. L’index de recherche de géocodage sera interrogé pour tous les éléments au-dessus des données au niveau de la rue. Aucune API n’est retournée. Notez que le géocodeur est très tolérant aux fautes de frappe et aux adresses incomplètes. Il gérera également tout à partir d’adresses de rue exactes ou de rues ou d’intersections ainsi que des zones géographiques de niveau supérieur telles que les centres urbains, les comtés, les états, etc.

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

Avec des paramètres facultatifs:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
query	query	True	string	L’adresse à rechercher (par exemple, « 1 Microsoft way, Redmond, WA »), doit être correctement codée par URL.
btmRight	query		string	Position inférieure droite du cadre englobant. Par exemple, 37,553,-122.453
countrySet	query		string[]	Chaîne séparée par des virgules de codes pays/région, par exemple FR,ES. Cela limitera la recherche aux pays/régions spécifiés
entityType	query		GeographicEntityType	Spécifie le niveau de filtrage effectué sur les zones géographiques. Limite la recherche des types d’entités géographiques spécifiés, par exemple, renvoyer uniquement la municipalité. La réponse résultante contiendra l’ID geography ainsi que le type d’entité mis en correspondance. Si vous fournissez plusieurs entités en tant que liste séparée par des virgules, le point de terminaison retourne l’entité la plus petite disponible. L’ID Geometry retourné peut être utilisé pour obtenir la géométrie de cette zone géographique via obtenir l’API Obtenir un polygone de recherche. Les paramètres suivants sont ignorés lorsque entityType est défini : rubrique nombre returnRoadUse returnSpeedLimit roadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : addr = Plages d’adresses Geo = Zones géographiques PAD = Adresses de point POI = Points d’intérêt Str = Rues XStr = Rues transversales (intersections) La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index. Par défaut, les codes postaux étendus sont inclus pour tous les index, à l’exception de Geo. Les listes de codes postaux étendus pour les zones géographiques peuvent être assez longues, de sorte qu’elles doivent être explicitement demandées si nécessaire. Exemples d'utilisation : extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.
language	query		string	Langue dans laquelle les résultats de recherche doivent être retournés. Doit être l’une des balises de langage IETF prises en charge, sans respect de la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez langues prises en charge.
lat	query		number (double)	Latitude où les résultats doivent être biaisés. Par exemple, 37,337
limit	query		integer minimum: 1 maximum: 100	Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100
lon	query		number (double)	Longitude où les résultats doivent être biaisés. Par exemple - 121,89
ofs	query		integer minimum: 0 maximum: 1900	Décalage de départ des résultats retournés dans le jeu de résultats complet. Valeur par défaut : 0
radius	query		integer	Rayon en mètres pour que les résultats soient limités à la zone définie
topLeft	query		string	Position supérieure gauche du cadre englobant. Par exemple, 37,553,-122.453
typeahead	query		boolean	Si le drapeau de saisie est activé, la requête sera interprétée comme une entrée partielle et la recherche passera en mode prédictif. Important : Cette propriété est obsolète et peut être omise dans la réponse.
view	query		LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l’emplacement de vos utilisateurs, puis de définir le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Indique le compte destiné à être utilisé avec le modèle de sécurité Microsoft Entra ID. Cet ID unique pour le compte Azure Maps peut être obtenu à partir de l’API de compte du plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

Réponses

Nom	Type	Description
200 OK	SearchAddressResult	D’ACCORD
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

Search detail address 15127 NE 24th Street, Redmond, WA 98052

Exemple de requête

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Exemple de réponse

Code d’état:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

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'.
LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l’emplacement de vos utilisateurs, puis de définir le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles.
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. Important : Cette propriété est obsolète et peut être omise dans la réponse.
ResponseFormat	Format souhaité de la réponse. La valeur peut être json ou xml.
SearchAddressResult	Cet objet est retourné à partir d’appels de recherche réussis.
SearchAddressResultItem	Objet Result pour une réponse d’API de recherche.
SearchAddressResultType	Un parmi : POI Rue Géographie Adresse exacte Plage d’adresses Croisement
SearchIndexes	Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : addr = Plages d’adresses Geo = Zones géographiques PAD = Adresses de point POI = Points d’intérêt Str = Rues XStr = Rues transversales (intersections) La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index. Par défaut, les codes postaux étendus sont inclus pour tous les index, à l’exception de Geo. Les listes de codes postaux étendus pour les zones géographiques peuvent être assez longues, de sorte qu’elles doivent être explicitement demandées si nécessaire. Exemples d'utilisation : extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.
SearchSummary	Objet résumé pour une réponse d’API de recherche.

Address

Objet

Adresse du résultat.

Nom	Type	Description
boundingBox	BoundingBoxCompassNotation	Définit le cadre de sélection de l’emplacement. Cette propriété n’est renvoyée que par les API d’inversion d’adresse de recherche. Toutes les autres API de recherche renvoient la `viewport` propriété de l’objet `SearchAddressResultItem` .
buildingNumber	string	Numéro de bâtiment sur la rue. Important : Cette propriété est obsolète. Utilisez `streetNumber` à la place.
country	string	Le nom du pays/région.
countryCode	string	Un code alphabétique de deux lettres défini par la norme ISO 3166-1 Alpha-2 pour représenter un pays/région et des territoires dépendants.
countryCodeISO3	string	Un code alphabétique de trois lettres défini par la norme ISO 3166-1 Alpha-3 pour représenter un pays/région et des territoires dépendants.
countrySecondarySubdivision	string	La division administrative de second niveau au sein d’un pays ou d’une région. Il identifie une subdivision située en dessous de la subdivision principale, comme l’État ou la province, mais au-dessus de petites unités comme les municipalités ou les quartiers. Parmi les exemples, on trouve County aux États-Unis et District au Royaume-Uni.
countrySubdivision	string	La division administrative principale au sein d’un pays, comme un État ou une province. Il est utilisé pour représenter la subdivision de premier niveau en dessous du niveau national.
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. Cette propriété n’est pas disponible dans l’API `Get Search Nearby` et `Get Search POI` .
countrySubdivisionName	string	Représente le nom complet de la division administrative de premier niveau (telle que l’État, la province ou la région) au sein d’un pays ou d’une région. Cette propriété n’est incluse que lorsque la `countrySubdivision` valeur est fournie sous forme abrégée. Actuellement soutenu pour les États-Unis, le Canada et le Royaume-Uni.
countryTertiarySubdivision	string	La division administrative de troisième niveau au sein d’un pays ou d’une région. Il offre une granularité encore plus fine que la subdivision secondaire (comme le comté ou le district). Des exemples incluent des municipalités telles qu’une ville, une commune, un village, un borough ou un canton, ainsi que des quartiers plus petits et informels au sein d’une municipalité, tels que Capitol Hill, Green Lake et Wallingford à Seattle.
crossStreet	string	Nom de la rue en cours de traversée. Cette propriété n’est disponible que dans l’API `Get Search Address Reverse Cross Street` .
extendedPostalCode	string	Un code postal étendu désigne un format de code postal qui va au-delà de l’ensemble standard de chiffres pour offrir une meilleure précision de localisation. Il est couramment utilisé dans des systèmes comme le code U.S. ZIP+4 ou des formats étendus similaires dans d’autres pays ou régions. La disponibilité dépend de la région. Non disponible dans l’API `Get Search Address Reverse Cross Street` .
freeformAddress	string	Une ligne d’adresse formatée selon les règles de mise en forme du pays/région d’origine d’un résultat, ou, dans le cas d’un pays/région, son nom complet du 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 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 communément connu de la ville ou de la commune, il est suggéré d’utiliser la `localName` valeur à la place de la `municipality` valeur.
municipalitySubdivision	string	Un lotissement au sein d’une municipalité. Il représente une unité administrative ou géographique plus petite au sein d’une ville, d’une commune ou d’une autre entité municipale.
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	Une série de chiffres ou de lettres (ou les deux) s’ajoutaient à une adresse pour aider à identifier une zone géographique spécifique. Un code postal est la version américaine d’un code postal, d’autres pays/régions utilisent d’autres formats tels que le code postal, le code PIN et le PLZ.
routeNumbers	string[]	Les codes utilisés pour identifier la rue sans ambiguïté. Disponible uniquement pour les API d’inversion d’adresse de recherche.
street	string	Nom de la rue. Important : Cette propriété est obsolète. Utilisez `streetName` à la place.
streetName	string	Nom de la rue.
streetNameAndNumber	string	Nom et numéro de la rue. Disponible uniquement pour les API d’inversion d’adresse de recherche.
streetNumber	string	Numéro de bâtiment sur la rue. Non disponible dans l’API `Get Search Address Reverse Cross Street` .

AddressRanges

Objet

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

Objet

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

Objet

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

Objet

Marque associée au POI

Nom	Type	Description
name	string	Nom de la marque

Classification

Objet

Classification du point de vue retourné

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

ClassificationName

Objet

Nom de la classification

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

DataSources

Objet

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

Objet

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

Objet

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

Objet

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

Objet

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
CountrySubdivision	État ou province
CountrySecondarySubdivision	Comté
CountryTertiarySubdivision	Zone nommée
Municipality	Ville / Ville
MunicipalitySubdivision	Sous-marin / Super ville
Neighbourhood	Voisinage
PostalCodeArea	Postal Code / Zip Code

Geometry

Objet

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

Objet

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é

LocalizedMapView

Énumération

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l’emplacement de vos utilisateurs, puis de définir le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN.

Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles.

Valeur	Description
AE	Émirats arabes unis (vue arabe)
AR	Argentine (vue argentine)
BH	Bahreïn (vue arabe)
IN	Inde (Vue indienne)
IQ	Irak (vue arabe)
JO	Jordanie (vue arabe)
KW	Koweït (vue arabe)
LB	Liban (vue arabe)
MA	Maroc (vue marocaine)
OM	Oman (vue arabe)
PK	Pakistan (vue pakistanaise)
PS	Autorité palestinienne (vue arabe)
QA	Qatar (vue arabe)
SA	Arabie saoudite (vue arabe)
SY	Syrie (vue arabe)
US	États-Unis d’Amérique
YE	Yémen (vue arabe)
Auto	Retournez les données cartographiques en fonction de l’adresse IP de la requête.
Unified	Affichage unifié (autres)

MatchType

Énumération

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

Valeur	Description
AddressPoint
HouseNumberRange
Street

OperatingHours

Objet

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

Objet

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

Objet

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

Objet

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

Objet

Catégorie POI

Nom	Type	Description
id	integer	ID de catégorie

QueryType

Énumération

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

Important : Cette propriété est obsolète et peut être omise dans la réponse.

Valeur	Description
NEARBY	La recherche était 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

ResponseFormat

Énumération

Format souhaité de la réponse. La valeur peut être json ou xml.

Valeur	Description
json	le format d’échange de données JavaScript Object Notation
xml	le langage de balisage extensible

SearchAddressResult

Objet

Cet objet est retourné à partir d’appels de recherche réussis.

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

SearchAddressResultItem

Objet

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. Important : Cette propriété est obsolète et peut être omise dans la réponse.
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
POI
Street
Geography
Point Address
Address Range
Cross Street

SearchIndexes

Énumération

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats.

Les index disponibles sont les suivants :

addr = Plages d’adresses

Geo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues transversales (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index, à l’exception de Geo. Les listes de codes postaux étendus pour les zones géographiques peuvent être assez longues, de sorte qu’elles doivent être explicitement demandées si nécessaire.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.

Valeur	Description
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Objet

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. Important : Cette propriété est obsolète et peut être omise dans la réponse.
totalResults	integer	Nombre total de résultats trouvés.