Search - Get Search Address Structured
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 Structured
(géocodage d’adresse structurée) est une requête HTTP GET
qui retourne 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’index de recherche de géocodage sera interrogé pour tout ce qui se trouve au-dessus des données au niveau de la rue. Aucun POI n’est retourné. Notez que le géocodeur est très tolérant aux fautes de frappe et aux adresses incomplètes. Il s’occupera également de tout, des adresses exactes des rues ou des intersections ainsi que des zones géographiques de niveau supérieur telles que les centres-villes, les comtés, les États, etc.
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&countryCode={countryCode}
GET https://atlas.microsoft.com/search/address/structured/{format}?api-version=1.0&language={language}&countryCode={countryCode}&limit={limit}&ofs={ofs}&streetNumber={streetNumber}&streetName={streetName}&crossStreet={crossStreet}&municipality={municipality}&municipalitySubdivision={municipalitySubdivision}&countryTertiarySubdivision={countryTertiarySubdivision}&countrySecondarySubdivision={countrySecondarySubdivision}&countrySubdivision={countrySubdivision}&postalCode={postalCode}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
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. |
country
|
query | True |
string |
Partie 2 ou 3 lettres ISO3166-1 de code pays/région d’une adresse. Par exemple, les États-Unis. |
country
|
query |
string |
Pays/région pour l’adresse structurée |
|
country
|
query |
string |
Partie de subdivision pays/région d’une adresse |
|
country
|
query |
string |
Zone nommée pour l’adresse structurée |
|
cross
|
query |
string |
Nom de la rue croisée de l’adresse structurée |
|
entity
|
query |
Spécifie le niveau de filtrage effectué sur les zones géographiques. Réduit la recherche des types d’entités géographiques spécifiés, par exemple, renvoyer uniquement une municipalité. La réponse obtenue contient l’ID de géographie, ainsi que le type d’entité mis en correspondance. Si vous fournissez plusieurs entités sous la forme d’une liste séparée par des virgules, le point de terminaison retourne la « plus petite entité disponible ». L’ID geometry retourné peut être utilisé pour obtenir la géométrie de cette zone géographique via Obtenir Recherche API Polygon. Les paramètres suivants sont ignorés lorsque entityType est défini :
|
||
extended
|
query |
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : Addr = Plages d’adresses Géo = Zones géographiques PAD = Adresses de point POI = Points d’intérêt Str = Rues XStr = Rues croisées (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 étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement en cas de besoin. 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 la recherche doivent être retournés. Doit être l’une des balises de langue 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 . |
|
limit
|
query |
integer |
Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100 |
|
municipality
|
query |
string |
La partie municipalité d’une adresse |
|
municipality
|
query |
string |
La subdivision municipale (sous/super-ville) pour l’adresse structurée |
|
ofs
|
query |
integer |
Décalage de départ des résultats retournés dans le jeu de résultats complet. Valeur par défaut : 0 |
|
postal
|
query |
string |
Partie du code postal d’une adresse |
|
street
|
query |
string |
Partie nom de rue d’une adresse |
|
street
|
query |
string |
Partie numéro de rue d’une adresse |
|
view
|
query |
Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique 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/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », 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 correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à 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, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris 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 |
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 |
Ok |
|
Other Status Codes |
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
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée qui est provisionnée 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
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 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
Dans:
header
Exemples
Search address in Redmond, WA in structured form
Exemple de requête
GET https://atlas.microsoft.com/search/address/structured/json?api-version=1.0&countryCode=US&streetNumber=15127&streetName=NE%2024th%20Street&municipality=Redmond&postalCode=98052
Exemple de réponse
{
"summary": {
"query": "15127 98052 ne redmond wa",
"queryType": "NON_NEAR",
"queryTime": 57,
"numResults": 1,
"offset": 0,
"totalResults": 34,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.30129317913035,
"lon": -120.88247999999997
}
},
"results": [
{
"type": "Point Address",
"id": "US/PAD/p0/37974392",
"score": 8.074,
"dist": 101274.64693865852,
"address": {
"streetNumber": "15127",
"streetName": "NE 24th St",
"municipalitySubdivision": "Redmond",
"municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide",
"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 98052",
"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 |
Address |
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. |
Bounding |
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. |
Bounding |
Zone englobante de l’emplacement. |
Brand |
Marque associée au POI |
Classification |
Classification du POINT d’identification retourné |
Classification |
Nom de la classification |
Data |
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. |
Entry |
Point d’entrée du POI retourné. |
Entry |
Type de point d’entrée. La valeur peut être main ou mineure. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Geographic |
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. |
Lat |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
Localized |
Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique 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/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », 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 correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à 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, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles. |
Match |
Types de correspondance pour une opération de recherche d’adresses inversées. |
Operating |
Heures d’ouverture d’un point d’intérêt pour un point d’intérêt. |
Operating |
Représente une date et une heure |
Operating |
Intervalle de temps ouvert pour un jour |
Point |
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. |
Point |
Catégorie POI |
Query |
Type de requête retourné : NEARBY ou NON_NEAR. |
Response |
Format souhaité de la réponse. La valeur peut être json ou xml. |
Search |
Cet objet est retourné à partir d’un Recherche appels réussis. |
Search |
Objet Result pour une réponse d’API Recherche. |
Search |
Valeurs possibles :
|
Search |
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : Addr = Plages d’adresses Géo = Zones géographiques PAD = Adresses de point POI = Points d’intérêt Str = Rues XStr = Rues croisées (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 étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement 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. |
Search |
Objet Summary pour une réponse d’API Recherche. |
Address
Adresse du résultat
Nom | Type | Description |
---|---|---|
boundingBox |
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 |
|
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 |
municipality |
string |
Ville/ Ville |
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 |
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 |
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 |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
|
topLeftPoint |
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 |
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 |
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 |
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 |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
|
type |
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 |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet error. |
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é |
LocalizedMapView
Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique 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/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », 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 correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à 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, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN.
Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.
Nom | Type | Description |
---|---|---|
AE |
string |
Émirats Arabes Unis (affichage arabe) |
AR |
string |
Argentine (affichage argentin) |
Auto |
string |
Retourne les données cartographiques correspondant à l’adresse IP de la requête. |
BH |
string |
Bahreïn (affichage arabe) |
IN |
string |
Inde (affichage indien) |
IQ |
string |
Irak (affichage arabe) |
JO |
string |
Jordanie (affichage arabe) |
KW |
string |
Koweït (affichage arabe) |
LB |
string |
Liban (affichage arabe) |
MA |
string |
Maroc (affichage marocain) |
OM |
string |
Oman (affichage arabe) |
PK |
string |
Pakistan (affichage pakistanais) |
PS |
string |
Autorité palestinienne (affichage arabe) |
QA |
string |
Qatar (affichage arabe) |
SA |
string |
Arabie Saoudite (affichage arabe) |
SY |
string |
Syrie (affichage arabe) |
Unified |
string |
Affichage unifié (Autres) |
YE |
string |
Yémen (affichage arabe) |
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 |
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 |
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 |
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 |
Liste des catégories de POI les plus spécifiques |
|
classifications |
Tableau de classification |
|
name |
string |
Nom de la propriété POI |
openingHours |
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 |
ResponseFormat
Format souhaité de la réponse. La valeur peut être json ou xml.
Nom | Type | Description |
---|---|---|
json |
string |
|
xml |
string |
SearchAddressResult
Cet objet est retourné à partir d’un Recherche appels réussis.
Nom | Type | Description |
---|---|---|
results |
Liste des résultats de l’API Recherche. |
|
summary |
Objet Summary pour une réponse d’API Recherche |
SearchAddressResultItem
Objet Result pour une réponse d’API Recherche.
Nom | Type | 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. |
|
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 de ligne droite entre le résultat et l’emplacement géographique en mètres. |
entityType |
Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible. |
|
entryPoints |
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, et « mineure », pour les portes latérales et arrière. |
|
id |
string |
Propriété Id |
info |
string |
Informations sur la source de données d’origine du résultat. Utilisé pour les demandes de support. |
matchType |
Informations sur le type de correspondance. Valeurs possibles :
|
|
poi |
Détails des poI retournés, notamment des informations telles que le nom, le téléphone, l’adresse URL et les classifications. |
|
position |
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 relative 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 |
Valeurs possibles :
|
|
viewport |
Fenêtre d’affichage qui couvre le résultat représenté par les coordonnées en haut à gauche et en bas à 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 |
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
Géo = Zones géographiques
PAD = Adresses de point
POI = Points d’intérêt
Str = Rues
XStr = Rues croisées (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 étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement 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.
Nom | Type | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
SearchSummary
Objet Summary pour une réponse d’API Recherche.
Nom | Type | Description |
---|---|---|
fuzzyLevel |
integer |
Niveau de flou maximal requis pour fournir des résultats. |
geoBias |
Indication quand 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, c’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 |
Type de requête retourné : NEARBY ou NON_NEAR. |
|
totalResults |
integer |
Nombre total de résultats trouvés. |