Search - Get Search POI
Permet de rechercher des points d’intérêt par nom.
L’API Points of Interest (POI) Search
est une requête http GET
qui vous permet de demander des résultats poI par nom. Il prend également en charge des paramètres de requête supplémentaires tels que la langue et le filtrage des résultats par zone d’intérêt pilotée par pays/région ou zone englobante. Le point de terminaison retourne uniquement les résultats poI correspondant à la chaîne de requête. La réponse inclut des détails de poI tels que l’adresse, l’emplacement de coordonnées et la catégorie.
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}&openingHours=nextSevenDays
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. |
query
|
query | True |
string |
Le nom du POI à rechercher (par exemple, « statue de liberté », « starbucks »), doit être correctement codé à l’URL. |
brand
|
query |
string[] |
Liste séparée par des virgules des noms de marque qui peuvent être utilisés pour restreindre le résultat à des marques spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs marques sont fournies, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés. Les marques qui contiennent un « », dans leur nom doivent être placées entre guillemets. Exemples d'utilisation : brandSet=Foo brandSet=Foo,Bar brandSet="A,B,Virgule C »,Bar |
|
btm
|
query |
string |
Position inférieure droite du cadre englobant. Par exemple, 37,553,-122.453 |
|
category
|
query |
integer[] |
Liste séparée par des virgules d’ID d’ensemble de catégories, qui peut être utilisée pour limiter le résultat à des catégories de points d’intérêt spécifiques. L’ordre d’ID n’a pas d’importance. Le nombre maximal de valeurs de
|
|
connector
|
query |
Liste séparée par des virgules des types de connecteurs qui pourraient être utilisés pour limiter le résultat à la station de véhicules électriques prenant en charge des types de connecteurs spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés. Les types de connecteurs disponibles sont les suivants :
Exemples d'utilisation : connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
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 |
|
extended
|
query |
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : POI = Points d’intérêt La valeur doit être poI ou Aucun pour désactiver les codes postaux étendus. Par défaut, les codes postaux étendus sont inclus. Exemples d'utilisation : extendedPostalCodesFor=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: 1maximum: 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: 0maximum: 1900 |
Décalage de départ des résultats retournés dans le jeu de résultats complet. Valeur par défaut : 0 |
|
opening
|
query |
Heures d’opération pour un point d’intérêt (points d’intérêt). La disponibilité des heures d’opération varie en fonction des données disponibles. S’il n’est pas passé, aucune information sur les heures d’ouverture n’est retournée. Valeur prise en charge : nextSevenDays |
||
radius
|
query |
integer |
Rayon en mètres pour que les résultats soient limités à la zone définie |
|
top
|
query |
string |
Position supérieure gauche du cadre englobant. Par exemple, 37,553,-122.453 |
|
typeahead
|
query |
boolean |
Booléen. Si l’indicateur typeahead est défini, la requête est interprétée comme une entrée partielle et la recherche entre en mode prédictif |
|
view
|
query |
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 |
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 |
D’ACCORD |
|
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é à '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 for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results
Exemple de requête
GET https://atlas.microsoft.com/search/poi/json?api-version=1.0&query=juice bars&limit=5&lat=47.606038&lon=-122.333345&radius=8046&openingHours=nextSevenDays
Exemple de réponse
{
"summary": {
"query": "juice bars",
"queryType": "NON_NEAR",
"queryTime": 36,
"numResults": 5,
"offset": 0,
"totalResults": 12,
"fuzzyLevel": 1,
"geoBias": {
"lat": 47.606038,
"lon": -122.333345
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/9223158",
"score": 5.664,
"dist": 667.2710170950347,
"info": "search:ta:840539001755244-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-6240804",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "400",
"streetName": "Pine St",
"municipalitySubdivision": "Seattle, Central Business District",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98101",
"extendedPostalCode": "981011628",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "400 Pine St, Seattle, WA 98101",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61138,
"lon": -122.3374
},
"viewport": {
"topLeftPoint": {
"lat": 47.61228,
"lon": -122.33873
},
"btmRightPoint": {
"lat": 47.61048,
"lon": -122.33607
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61134,
"lon": -122.33737
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9222534",
"score": 5.663,
"dist": 1101.6849025777728,
"info": "search:ta:840539001760125-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-4533785",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "315",
"streetName": "E Pine St",
"municipalitySubdivision": "Seattle, Broadway",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98122",
"extendedPostalCode": "9812200",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "315 E Pine St, Seattle, WA 98122",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.61518,
"lon": -122.32768
},
"viewport": {
"topLeftPoint": {
"lat": 47.61608,
"lon": -122.32901
},
"btmRightPoint": {
"lat": 47.61428,
"lon": -122.32635
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.61523,
"lon": -122.32768
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9133689",
"score": 5.659,
"dist": 2649.8700791555398,
"info": "search:ta:840539001339220-US",
"poi": {
"name": "Pressed Juicery",
"phone": "+(1)-(206)-2820651",
"brands": [
{
"name": "Pressed Juicery"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.pressedjuicery.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "604",
"streetName": "1st Ave N",
"municipalitySubdivision": "Seattle, Lower Queen Anne",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98109",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "604 1st Ave N, Seattle, WA 98109",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.6247,
"lon": -122.35533
},
"viewport": {
"topLeftPoint": {
"lat": 47.6256,
"lon": -122.35666
},
"btmRightPoint": {
"lat": 47.6238,
"lon": -122.354
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.6247,
"lon": -122.3554
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/9131285",
"score": 5.646,
"dist": 5097.757019046541,
"info": "search:ta:840539001743255-US",
"poi": {
"name": "Custom Smoothie & Sports Nutrition",
"phone": "+(1)-(206)-5475522",
"categorySet": [
{
"id": 7315149
}
],
"url": "www.customsmoothie.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "462",
"streetName": "N 34th St",
"municipalitySubdivision": "Seattle, Fremont",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981038600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "462 N 34th St, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.65016,
"lon": -122.35182
},
"viewport": {
"topLeftPoint": {
"lat": 47.65106,
"lon": -122.35315
},
"btmRightPoint": {
"lat": 47.64926,
"lon": -122.35049
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.64991,
"lon": -122.3519
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/9228250",
"score": 5.637,
"dist": 6235.798481758295,
"info": "search:ta:840531000416784-US",
"poi": {
"name": "Jamba Juice",
"phone": "+(1)-(206)-6322060",
"brands": [
{
"name": "Jamba Juice"
}
],
"categorySet": [
{
"id": 7315149
}
],
"url": "www.jambajuice.com",
"classifications": [
{
"code": "RESTAURANT",
"names": [
{
"nameLocale": "en-US",
"name": "yogurt/juice bar"
},
{
"nameLocale": "en-US",
"name": "restaurant"
}
]
}
]
},
"address": {
"streetNumber": "4555",
"streetName": "Stone Way N",
"municipalitySubdivision": "Wallingford, Seattle",
"municipality": "Seattle",
"countrySecondarySubdivision": "King",
"countryTertiarySubdivision": "Seattle",
"countrySubdivisionCode": "WA",
"postalCode": "98103",
"extendedPostalCode": "981036600",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "4555 Stone Way N, Seattle, WA 98103",
"localName": "Seattle",
"countrySubdivisionName": "Washington"
},
"position": {
"lat": 47.66179,
"lon": -122.34233
},
"viewport": {
"topLeftPoint": {
"lat": 47.66269,
"lon": -122.34367
},
"btmRightPoint": {
"lat": 47.66089,
"lon": -122.34099
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 47.66188,
"lon": -122.34211
}
}
]
}
]
}
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 obtenir un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses. |
Bounding |
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 de vue retourné |
Classification |
Nom de la classification |
Data |
Section facultative. ID de référence à utiliser avec l’API Obtenir le polygone de recherche. |
Electric |
Liste séparée par des virgules des types de connecteurs qui pourraient être utilisés pour limiter le résultat à la station de véhicules électriques prenant en charge des types de connecteurs spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés. Les types de connecteurs disponibles sont les suivants :
Exemples d'utilisation : connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Source de type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position. |
Entry |
Point d’entrée pour le point d’identification du point d’identification retourné. |
Entry |
Type de point d’entrée. La valeur peut être principale 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é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. |
Lat |
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'. |
Localized |
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. |
Match |
Types de correspondance pour une opération de recherche d’adresse inversée. |
Operating |
Heures d’ouverture d’un POI (Points d’intérêt). |
Operating |
Heures d’opération pour un point d’intérêt (points d’intérêt). La disponibilité des heures d’opération varie en fonction des données disponibles. S’il n’est pas passé, aucune information sur les heures d’ouverture n’est retournée. Valeur prise en charge : nextSevenDays |
Operating |
Représente une date et une heure |
Operating |
Intervalle de temps ouvert pour une journée |
Point |
Détails du poI retourné, y compris les informations telles que le nom, le téléphone, l’adresse URL et les classifications. |
Point |
Catégorie POI |
Point |
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants : POI = Points d’intérêt La valeur doit être poI ou Aucun pour désactiver les codes postaux étendus. Par défaut, les codes postaux étendus sont inclus. Exemples d'utilisation : extendedPostalCodesFor=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. |
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’appels de recherche réussis. |
Search |
Objet Result pour une réponse d’API de recherche. |
Search |
Un parmi :
|
Search |
Objet résumé pour une réponse d’API de recherche. |
Address
Adresse du résultat
Nom | Type | Description |
---|---|---|
boundingBox |
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 |
|
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é |
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 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
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 |
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 |
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'. |
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.
Nom | Type | Description |
---|---|---|
btmRightPoint |
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'. |
|
topLeftPoint |
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'. |
BoundingBoxCompassNotation
Zone englobante de l’emplacement.
Nom | Type | Description |
---|---|---|
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
Marque associée au POI
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la marque |
Classification
Classification du point de vue retourné
Nom | Type | Description |
---|---|---|
code |
string |
Propriété de code |
names |
Tableau de noms |
ClassificationName
Nom de la classification
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la propriété |
nameLocale |
string |
Name Locale, propriété |
DataSources
Section facultative. ID de référence à utiliser avec l’API Obtenir le polygone de recherche.
Nom | Type | Description |
---|---|---|
geometry |
Informations sur la forme géométrique du résultat. Présente uniquement si type == Geography. |
ElectricVehicleConnector
Liste séparée par des virgules des types de connecteurs qui pourraient être utilisés pour limiter le résultat à la station de véhicules électriques prenant en charge des types de connecteurs spécifiques. L’ordre des articles n’a pas d’importance. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une des listes fournies sont retournés.
Les types de connecteurs disponibles sont les suivants :
-
StandardHouseholdCountrySpecific
: il s’agit des connecteurs ménagers standard pour une certaine région. Il s’agit de toutes les phases uniques AC et de la tension standard et de l’ampérage standard. Voir aussi : types de sockets Plug-& - World Standards. -
IEC62196Type1
- Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Également appelé Yazaki après le fabricant d’origine ou SAE J1772 après la norme qui l’a publiée pour la première fois. Principalement utilisé en combinaison avec une seule phase 120V ou jusqu’à 240V infrastructure à phase unique. -
IEC62196Type1CCS
- Connecteur combiné de type 1 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 1 , tel que défini dans la norme IEC 62196-2 , avec deux contacts à courant direct (DC) supplémentaires pour permettre la recharge rapide dc. -
IEC62196Type2CableAttached
- Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni en tant que câble et plug attachés au point de recharge. -
IEC62196Type2Outlet
- Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni en tant que socket défini dans le point de recharge. -
IEC62196Type2CCS
- Connecteur combo de type 2 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 2 , tel que défini dans la norme IEC 62196-2 , avec deux contacts de courant direct (DC) supplémentaires pour permettre la recharge rapide dc. -
IEC62196Type3
- Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Aussi appelé Scame après le fabricant d’origine. Principalement utilisé en combinaison avec jusqu’à 240V en phase unique ou jusqu’à 420V infrastructure en trois phases. -
Chademo
- Connecteur CHAdeMO nommé après une association formée par tokyo Electric Power Company et des partenaires industriels. En raison de cela, il est également appelé connecteur de TEPCO. Il prend en charge la recharge rapide du contrôleur de domaine. -
IEC60309AC1PhaseBlue
- Le connecteur Bleu industriel est un connecteur défini dans la norme IEC 60309. Il est parfois appelé par une combinaison de la norme, de la couleur et du fait qu’il s’agit d’un connecteur à phase unique. Le connecteur a généralement la configuration « P+N+E, 6h ». -
IEC60309DCWhite
- Le connecteur Blanc industriel est un connecteur DC défini dans la norme IEC 60309. -
Tesla
- Le connecteur Tesla est le connecteur Tesla spécifique à la région Supercharger. C’est-à-dire qu’il fait référence au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à l’Amérique du Nord ou au type 2 modifié (DC over Type 2) en Europe.
Exemples d'utilisation :
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Valeur | Description |
---|---|
Chademo |
Connecteur CHAdeMO nommé après une association formée par tokyo Electric Power Company et des partenaires industriels. En raison de cela, il est également appelé connecteur de TEPCO. Il prend en charge la recharge rapide du contrôleur de domaine. |
IEC60309AC1PhaseBlue |
Le connecteur Blue industriel est un connecteur défini dans la norme IEC 60309. Il est parfois appelé par une combinaison de la norme, de la couleur et du fait qu’il s’agit d’un connecteur à phase unique. Le connecteur a généralement la configuration « P+N+E, 6h ». |
IEC60309DCWhite |
Le connecteur Blanc industriel est un connecteur DC défini dans la norme IEC 60309. |
IEC62196Type1 |
Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Également appelé Yazaki après le fabricant d’origine ou SAE J1772 après la norme qui l’a publiée pour la première fois. Principalement utilisé en combinaison avec une seule phase 120V ou jusqu’à 240V infrastructure à phase unique. |
IEC62196Type1CCS |
Connecteur combo de type 1 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 1 , tel que défini dans la norme IEC 62196-2 , avec deux contacts à courant direct (DC) supplémentaires pour permettre la recharge rapide dc. |
IEC62196Type2CCS |
Connecteur combo de type 2 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 2 , tel que défini dans la norme IEC 62196-2 , avec deux contacts de courant direct (DC) supplémentaires pour permettre la recharge rapide dc. |
IEC62196Type2CableAttached |
Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni en tant que câble et plug attachés au point de recharge |
IEC62196Type2Outlet |
Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni en tant que socket défini dans le point de recharge. |
IEC62196Type3 |
Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Aussi appelé Scame après le fabricant d’origine. Principalement utilisé en combinaison avec jusqu’à 240V en phase unique ou jusqu’à 420V infrastructure en trois phases. |
StandardHouseholdCountrySpecific |
Il s’agit des connecteurs ménagers standard pour une certaine région. Il s’agit de toutes les phases uniques AC et de la tension standard et de l’ampérage standard. Voir aussi : types de sockets plug-& plug-- World Standards |
Tesla |
Le connecteur Tesla est le connecteur Tesla spécifique à la région Supercharger. C’est-à-dire qu’il fait référence au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à l’Amérique du Nord ou au type 2 modifié (DC over Type 2) en Europe. |
Entity
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
Point d’entrée pour le point d’identification du point d’identification retourné.
Nom | Type | Description |
---|---|---|
position |
Un emplacement représenté sous la forme d’une latitude et d’une longitude à l’aide de noms courts & 'lon'. |
|
type |
Type de point d’entrée. La valeur peut être principale ou mineure . |
EntryPointType
Type de point d’entrée. La valeur peut être principale ou mineure .
Valeur | Description |
---|---|
main | |
minor |
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émentaire. |
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 d’erreur. |
GeographicEntityType
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
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
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
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) |
Auto |
Retournez les données cartographiques en fonction de l’adresse IP de la requête. |
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) |
Unified |
Affichage unifié (autres) |
YE |
Yémen (vue arabe) |
MatchType
Types de correspondance pour une opération de recherche d’adresse inversée.
Valeur | Description |
---|---|
AddressPoint | |
HouseNumberRange | |
Street |
OperatingHours
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 |
Liste des intervalles de temps pour les 7 prochains jours |
OperatingHoursRange
Heures d’opération pour un point d’intérêt (points d’intérêt). La disponibilité des heures d’opération varie en fonction des données disponibles. S’il n’est pas passé, aucune information sur les heures d’ouverture n’est retournée. Valeur prise en charge : nextSevenDays
Valeur | Description |
---|---|
nextSevenDays |
Affiche les heures d’opération de la semaine suivante, en commençant par le jour actuel dans l’heure locale de l’OBJET. |
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 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
Intervalle de temps ouvert pour une journée
Nom | Type | Description |
---|---|---|
endTime |
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 |
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
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 |
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 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
Catégorie POI
Nom | Type | Description |
---|---|---|
id |
integer |
ID de catégorie |
PointOfInterestExtendedPostalCodes
Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats.
Les index disponibles sont les suivants :
POI = Points d’intérêt
La valeur doit être poI ou Aucun pour désactiver les codes postaux étendus.
Par défaut, les codes postaux étendus sont inclus.
Exemples d'utilisation :
extendedPostalCodesFor=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 |
---|---|
None | |
POI |
QueryType
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 |
ResponseFormat
Format souhaité de la réponse. La valeur peut être json ou xml.
Valeur | Description |
---|---|
json | |
xml |
SearchAddressResult
Cet objet est retourné à partir d’appels de recherche réussis.
Nom | Type | Description |
---|---|---|
results |
Liste des résultats de l’API de recherche. |
|
summary |
Objet summary pour une réponse d’API de recherche |
SearchAddressResultItem
Objet Result pour une réponse d’API de 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 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 |
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 |
Type d’entité geography. Présentez uniquement quand 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 « 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 |
Informations sur le type de correspondance. Un parmi :
|
|
poi |
Détails du poI retourné, y compris les informations telles que le nom, le téléphone, l’adresse URL et les classifications. |
|
position |
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 |
Un parmi :
|
|
viewport |
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
Un parmi :
- POI
- Rue
- Géographie
- Adresse exacte
- Plage d’adresses
- Croisement
Valeur | Description |
---|---|
Address Range | |
Cross Street | |
Geography | |
POI | |
Point Address | |
Street |
SearchSummary
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 |
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 |
Type de requête retourné : NEARBY ou NON_NEAR. |
|
totalResults |
integer |
Nombre total de résultats trouvés. |