Search - Get Search POI Category
Utilisez pour rechercher des points d’intérêt par catégorie.
L’API Get Search POI Category
est une requête HTTP GET
qui vous permet de demander des résultats poI à partir d’une catégorie donnée. Utile pour interroger des POINTS d’intérêt d’une catégorie à la fois. Le point de terminaison retourne uniquement les résultats de poI qui sont classés comme spécifiés. La réponse inclut des détails de poI tels que l’adresse, l’emplacement des coordonnées et la classification.
GET https://atlas.microsoft.com/search/poi/category/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/poi/category/{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 |
La catégorie poI à rechercher (par exemple, « AIRPORT », « RESTAURANT ») doit être correctement codée sur l’URL. Les catégories de main prises en charge peuvent être demandées en appelant Obtenir Recherche API d’arborescence de catégories poI. Pour obtenir la liste des catégories disponibles, consultez Azure Maps catégories prises en charge. Nous vous recommandons d’utiliser l’API d’arborescence de catégories Recherche poI pour demander les catégories prises en charge. |
brand
|
query |
string[] |
Liste séparée par des virgules des noms de marques qui peuvent être utilisés pour limiter le résultat à des marques spécifiques. L’ordre des éléments importe peu. 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,C Comma »,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 des ID n’a pas d’importance. Le nombre maximal de
|
|
connector
|
query |
Liste séparée par des virgules des types de connecteurs qui peuvent ê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 éléments importe peu. 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égions, 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 : 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. |
||
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, ne respectant pas 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 |
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 |
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’ouverture d’un point d’intérêt (points d’intérêt). La disponibilité des heures de fonctionnement varie en fonction des données disponibles. Si ce n’est pas le cas, aucune information sur les heures d’ouverture ne sera 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 |
Propriété booléenne. Si l’indicateur typeahead est défini, la requête est interprétée comme une entrée partielle et la recherche passe 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 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 le compte 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 ressource 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 . - est
Authorization URL
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, cli, kits SDK Azure ou 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, nous vous recommandons 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 Répertorier les SAP 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 précis à l’expiration, au taux et à la ou les régions d’utilisation du 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 Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAS.
Type:
apiKey
Dans:
header
Exemples
Search for ATM's within 2 miles of Times Square NY and return the top 3 results
Exemple de requête
GET https://atlas.microsoft.com/search/poi/category/json?api-version=1.0&query=atm&limit=3&lat=40.758953&lon=-73.985263&radius=3200&openingHours=nextSevenDays
Exemple de réponse
{
"summary": {
"query": "atm",
"queryType": "NON_NEAR",
"queryTime": 28,
"numResults": 3,
"offset": 0,
"totalResults": 3696,
"fuzzyLevel": 1,
"geoBias": {
"lat": 40.758953,
"lon": -73.985263
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p0/7014613",
"score": 2.575,
"dist": 10.743802093311858,
"info": "search:ta:840369001846523-US",
"poi": {
"name": "FISERV MASTERMONEY",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1560",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"extendedPostalCode": "100361517",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1560 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75901,
"lon": -73.98516
},
"viewport": {
"topLeftPoint": {
"lat": 40.75991,
"lon": -73.98635
},
"btmRightPoint": {
"lat": 40.75811,
"lon": -73.98397
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.75902,
"lon": -73.98522
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/6830011",
"score": 2.575,
"dist": 58.68107354501256,
"info": "search:ta:840369011803697-US",
"poi": {
"name": "METABANK",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1567",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"extendedPostalCode": "100361517",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1567 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75937,
"lon": -73.98569
},
"viewport": {
"topLeftPoint": {
"lat": 40.76027,
"lon": -73.98688
},
"btmRightPoint": {
"lat": 40.75847,
"lon": -73.9845
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.75924,
"lon": -73.98513
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/6830013",
"score": 2.575,
"dist": 55.009653221373966,
"info": "search:ta:840369010525390-US",
"poi": {
"name": "ATM",
"categorySet": [
{
"id": 7397
}
],
"classifications": [
{
"code": "CASH_DISPENSER",
"names": [
{
"nameLocale": "en-US",
"name": "cash dispenser"
}
]
}
]
},
"address": {
"streetNumber": "1552",
"streetName": "Broadway",
"municipalitySubdivision": "Times Square, New York, Midtown",
"municipality": "New York, Manhattan",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10036",
"countryCode": "US",
"country": "United States",
"countryCodeISO3": "USA",
"freeformAddress": "1552 Broadway, New York, NY 10036",
"localName": "New York",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.75873,
"lon": -73.98468
},
"viewport": {
"topLeftPoint": {
"lat": 40.75963,
"lon": -73.98587
},
"btmRightPoint": {
"lat": 40.75783,
"lon": -73.98349
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.7588,
"lon": -73.98492
}
}
]
}
]
}
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 |
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. |
Bounding |
Cadre englobant de l’emplacement. |
Brand |
Marque associée au poI |
Classification |
Classification du poI retourné |
Classification |
Nom de la classification |
Data |
Section facultative. Id de référence à utiliser avec l’API Obtenir Recherche Polygon. |
Electric |
Liste séparée par des virgules des types de connecteurs qui peuvent ê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 éléments importe peu. 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 du type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à 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’adresse inverse. |
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 de fonctionnement varie en fonction des données disponibles. Si ce n’est pas le cas, aucune information sur les heures d’ouverture ne sera retournée. Valeur prise en charge : nextSevenDays |
Operating |
Représente une date et une heure |
Operating |
Plage horaire ouverte pour une journée |
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 d’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 |
Cadre englobant de l’emplacement. |
|
buildingNumber |
string |
Numéro de l’immeuble dans la rue. DEPRECATED, utilisez streetNumber à la place. |
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 ou d’une ville avec des caractéristiques distinctives et des interactions sociales entre les habitants. |
postalCode |
string |
Postal Code / Zip Code |
routeNumbers |
string[] |
Les 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 rue. |
streetNumber |
string |
Numéro de l’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
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.
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
Cadre englobant de l’emplacement.
Nom | Type | Description |
---|---|---|
entity |
Source du 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 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 poI 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 Obtenir Recherche Polygon.
Nom | Type | Description |
---|---|---|
geometry |
Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography. |
ElectricVehicleConnector
Liste séparée par des virgules des types de connecteurs qui peuvent ê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 éléments importe peu. 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. Ils sont tous ca monophasé et la tension standard et l’ampéage standard. Voir aussi : Types de sockets plug-& - Normes mondiales. -
IEC62196Type1
- Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Également appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié pour la première fois. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou jusqu’à 240 V en 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 de courant continu (DC) supplémentaires pour permettre la charge rapide dc. -
IEC62196Type2CableAttached
- Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous la forme d’un câble et d’une fiche fixés au point de charge. -
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 charge. -
IEC62196Type2CCS
- Connecteur combiné 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 continu (DC) supplémentaires pour permettre la charge rapide dc. -
IEC62196Type3
- Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Également appelé Scame après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240 V ou jusqu’à 420 V en trois phases. -
Chademo
- Connecteur CHAdeMO nommé d’après une association formée par la Tokyo Electric Power Company et des partenaires industriels. Pour cette raison, est également connu sous le nom de connecteur de TEPCO. Il prend en charge la charge dc rapide. -
IEC60309AC1PhaseBlue
- Le connecteur Industrial Blue 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 Industrial White est un connecteur DC défini dans la norme IEC 60309. -
Tesla
- Le connecteur Tesla est le connecteur Tesla Supercharger spécifique à la région. C’est-à-dire qu’il fait référence au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord ou au type 2 modifié (DC sur type 2) en Europe.
Exemples d'utilisation :
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Nom | Type | Description |
---|---|---|
Chademo |
string |
Connecteur CHAdeMO nommé d’après une association formée par la Tokyo Electric Power Company et des partenaires industriels. Pour cette raison, est également connu sous le nom de connecteur de TEPCO. Il prend en charge la charge dc rapide. |
IEC60309AC1PhaseBlue |
string |
Le connecteur Industrial Blue 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 |
string |
Le connecteur Industrial White est un connecteur DC défini dans la norme IEC 60309. |
IEC62196Type1 |
string |
Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Également appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié pour la première fois. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou jusqu’à 240 V en phase unique. |
IEC62196Type1CCS |
string |
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 de courant continu (DC) supplémentaires pour permettre la charge rapide dc. |
IEC62196Type2CCS |
string |
Connecteur combiné 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 continu (DC) supplémentaires pour permettre la charge rapide dc. |
IEC62196Type2CableAttached |
string |
Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous la forme d’un câble et d’une prise fixés au point de charge |
IEC62196Type2Outlet |
string |
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 charge. |
IEC62196Type3 |
string |
Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Également appelé Scame après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240 V ou jusqu’à 420 V en trois phases. |
StandardHouseholdCountrySpecific |
string |
Il s’agit des connecteurs ménagers standard pour une certaine région. Ils sont tous ca monophasé et la tension standard et l’ampéage standard. Voir aussi : Types de sockets plug-& - Normes mondiales |
Tesla |
string |
Le connecteur Tesla est le connecteur Tesla Supercharger spécifique à la région. C’est-à-dire qu’il fait référence au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord ou au type 2 modifié (DC sur type 2) en Europe. |
Entity
Source du type d’entité du cadre englobant. Pour le géocodage inverse, cela est toujours égal à la position.
Nom | Type | Description |
---|---|---|
position |
string |
Entité 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 d’erreur. |
GeographicEntityType
Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.
Nom | Type | Description |
---|---|---|
Country |
string |
nom du pays/de la région |
CountrySecondarySubdivision |
string |
County |
CountrySubdivision |
string |
State or Province |
CountryTertiarySubdivision |
string |
Zone nommée |
Municipality |
string |
Ville/ Ville |
MunicipalitySubdivision |
string |
Sub / Super City |
Neighbourhood |
string |
Quartier |
PostalCodeArea |
string |
Postal Code / Zip Code |
Geometry
Informations sur la forme géométrique du résultat. Présent uniquement si type == Geography.
Nom | Type | Description |
---|---|---|
id |
string |
Transmettez ce paramètre en tant que geometryId à l’API Get Recherche Polygon pour extraire les informations géométriques de 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’adresse inverse.
Nom | Type | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
OperatingHours
Heures d’ouverture d’un POI (Points 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 |
OperatingHoursRange
Heures d’opération pour un POINT d’intérêt (POINTS D’INTÉRÊT). La disponibilité des heures de fonctionnement varie en fonction des données disponibles. Si ce n’est pas le cas, aucune information sur les heures d’ouverture ne sera retournée. Valeur prise en charge : nextSevenDays
Nom | Type | Description |
---|---|---|
nextSevenDays |
string |
Affiche les heures d’ouverture de la semaine suivante, en commençant par le jour actuel à l’heure locale du POINT d’identification. |
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 personnelle ; les valeurs possibles sont 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
Plage horaire ouverte pour une journée
Nom | Type | Description |
---|---|---|
endTime |
Point dans la plage de 7 jours suivant quand 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 suivant quand 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 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 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 d’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 en 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 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. Valeurs possibles :
|
|
poi |
Détails du POINT d’identification retourné, y compris des informations telles que le nom, le téléphone, l’adresse URL et les classifications. |
|
position |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
|
score |
number |
Valeur dans un jeu de résultats pour indiquer le score de correspondance relatif entre les résultats. Vous pouvez l’utiliser pour déterminer que le résultat x est deux fois plus susceptible d’être aussi pertinent que le résultat y si la valeur de x est 2x la valeur de y. Les valeurs varient d’une requête à l’autre et sont uniquement destinées à une valeur relative pour un jeu de résultats. |
type |
Valeurs possibles :
|
|
viewport |
La fenêtre d’affichage qui couvre le résultat représenté par les coordonnées supérieure gauche et inférieure droite de la fenêtre d’affichage. |
SearchAddressResultType
Valeurs possibles :
- POI
- Rue
- Geography
- Adresse exacte
- Plage d’adresses
- Croisement
Nom | Type | Description |
---|---|---|
Address Range |
string |
|
Cross Street |
string |
|
Geography |
string |
|
POI |
string |
|
Point Address |
string |
|
Street |
string |
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 flou maximal requis pour fournir des 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 lorsqu’ils sont disponibles. Dans d’autres cas, elle est purement interne. |
|
limit |
integer |
Nombre maximal de réponses qui seront retournées |
numResults |
integer |
Nombre de résultats dans la réponse. |
offset |
integer |
Décalage de départ du résultat retourné dans le jeu de résultats complet. |
query |
string |
Paramètre de requête utilisé pour produire ces résultats de recherche. |
queryTime |
integer |
Temps passé à résoudre la requête, en millisecondes. |
queryType |
Type de requête retourné : NEARBY ou NON_NEAR. |
|
totalResults |
integer |
Nombre total de résultats trouvés. |