Search - Get Search POI

  • Référence
Service:
Maps
API Version:
1.0

Utilisez pour 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, selon le pays/la région ou le cadre englobant. Le point de terminaison retourne uniquement les résultats de poI correspondant à la chaîne de requête. La réponse inclut des détails de poI tels que l’adresse, l’emplacement des coordonnées et la catégorie.

GET https://atlas.microsoft.com/search/poi/{format}?api-version=1.0&query={query}
With optional parameters: 
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

ResponseFormat

Format souhaité de la réponse. La valeur peut être json ou xml.
api-version
 query True

string

Numéro de version de l’API Azure Maps.
query
 query True

string

Le nom poI à rechercher (par exemple, « statue de la liberté », « starbucks ») doit être correctement codé dans l’URL.
brandSet
 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
btmRight
 query

string

Position inférieure droite du cadre englobant. Par exemple, 37.553,-122.453
categorySet
 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 categorySet valeurs prises en charge par demande est de 10. Lorsque plusieurs identificateurs de catégorie sont fournis, seuls les points d’accès qui appartiennent à (au moins) une des catégories de la liste fournie sont retournés. La liste des catégories prises en charge peut être découverte à l’aide de l’API Catégories poI . Exemples d'utilisation :

  • categorySet=7315 (Recherche points d’intérêt de la catégorie Restaurant)

  • categorySet=7315025,7315017 (Recherche points d’intérêt de la catégorie Restaurant italien ou Français)
connectorSet
 query

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
countrySet
 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.
extendedPostalCodesFor
 query

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 None 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 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
openingHours
 query

OperatingHoursRange

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
topLeft
 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

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.

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

SearchAddressResult

Ok
Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé 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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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
In: 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
In: header

Exemples

Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results

Sample Request

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

Sample Response

Status code:
200 
{
  "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
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.
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.
BoundingBoxCompassNotation

Cadre englobant de l’emplacement.
Brand

Marque associée au poI
Classification

Classification du poI retourné
ClassificationName

Nom de la classification
DataSources

Section facultative. Id de référence à utiliser avec l’API Obtenir Recherche Polygon.
ElectricVehicleConnector

Liste séparée par des virgules de types de connecteurs qui peuvent être utilisés pour limiter le résultat à Electric Vehicle Station 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 de la liste fournie sont retournés.

Les types de connecteurs disponibles sont les suivants :

  • StandardHouseholdCountrySpecific - Il s’agit des connecteurs domestiques standard pour une région donnée. Ils sont tous ca monophasé et la tension standard et l’ampérage standard. Voir aussi : Types de sockets plug-& - Normes mondiales.
  • IEC62196Type1 - Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Aussi appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié en premier. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou monophase 240V maximum.
  • 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 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 forme de câble et de prise attaché au point de charge.
  • IEC62196Type2Outlet - Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous la forme d’une prise définie dans le point de charge.
  • 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 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. Aussi appelé Scame d’après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240V ou jusqu’à 420V 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 une charge cc 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 monophase. 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 soit au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord, soit au type 2 modifié (DC sur type 2) en Europe.

Exemples d'utilisation :

connectorSet=IEC62196Type2Cable ConnectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Entity

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

Point d’entrée du poI retourné.
EntryPointType

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

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
GeographicEntityType

Type d’entité Geography. Pré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.
LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les 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 à l’affichage requis 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 ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN.

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

Types de correspondance pour une opération de recherche d’adresse inverse.
OperatingHours

Heures d’ouverture d’un POI (Points d’intérêt).
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
OperatingHoursTime

Représente une date et une heure
OperatingHoursTimeRange

Plage horaire ouverte pour une journée
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.
PointOfInterestCategorySet

Catégorie POI
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 None 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.
QueryType

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

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

Cet objet est retourné à partir d’un Recherche d’appels réussis.
SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.
SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
SearchSummary

Objet summary pour une réponse d’API Recherche.

Address

Adresse du résultat

Nom Type Description
boundingBox

BoundingBoxCompassNotation

Cadre englobant 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

countrySubdivisionCode préfixé par countryCode ( countryCode-countrySubdivisionCode ) et le trait d’union forme le code ISO 3166-2. Exemples : TX pour le Texas, SCT pour l’Écosse et ON pour l’Ontario.
countrySubdivisionName

string

Nom complet d’un premier niveau de hiérarchie administrative pays/région. Ce champ apparaît uniquement dans le cas où countrySubdivision est présenté sous 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 freeformAddress propriété . localName représente la municipalité postale. Selon l’emplacement, localName est le nom communément connu d’une ville ou d’une ville. Pour le nom couramment connu d’une ville ou d’une ville, utilisez localName au lieu de municipality.
municipality

string

Ville / Ville
Remarque : municipality représente la municipalité résidentielle. Selon l’emplacement, la municipality valeur peut différer du nom communément connu d’une ville ou d’une ville. Pour le nom couramment connu de la ville ou de la ville, il est suggéré d’utiliser la localName valeur à la place de la municipality valeur.
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

LatLongPairAbbreviated

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

LatLongPairAbbreviated

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

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
topLeftPoint

LatLongPairAbbreviated

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

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

ClassificationName[]

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

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 de types de connecteurs qui peuvent être utilisés pour limiter le résultat à Electric Vehicle Station 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 de la liste fournie sont retournés.

Les types de connecteurs disponibles sont les suivants :

  • StandardHouseholdCountrySpecific - Il s’agit des connecteurs domestiques standard pour une région donnée. Ils sont tous ca monophasé et la tension standard et l’ampérage standard. Voir aussi : Types de sockets plug-& - Normes mondiales.
  • IEC62196Type1 - Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Aussi appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié en premier. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou monophase 240V maximum.
  • 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 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 forme de câble et de prise attaché au point de charge.
  • IEC62196Type2Outlet - Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous la forme d’une prise définie dans le point de charge.
  • 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 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. Aussi appelé Scame d’après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240V ou jusqu’à 420V 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 une charge cc 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 monophase. 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 soit au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord, soit au type 2 modifié (DC sur type 2) en Europe.

Exemples d'utilisation :

connectorSet=IEC62196Type2Cable 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 une charge cc 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 monophase. 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. Aussi appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié en premier. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou monophase 240V maximum.
IEC62196Type1CCS

string

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 de courant continu (DC) supplémentaires pour permettre la charge rapide DC.
IEC62196Type2CCS

string

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 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 forme de câble et de prise attaché au point de charge
IEC62196Type2Outlet

string

Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous la forme d’une prise définie dans le point de charge.
IEC62196Type3

string

Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Aussi appelé Scame d’après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240V ou jusqu’à 420V en trois phases.
StandardHouseholdCountrySpecific

string

Il s’agit des connecteurs domestiques standard pour une région donnée. Ils sont tous ca monophasé et la tension standard et l’ampérage 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 soit au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord, soit 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

LatLongPairAbbreviated

Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
type

EntryPointType

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

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

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 correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les 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 à l’affichage requis 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 ou de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont disponibles. Exemple : view=IN.

Reportez-vous à Vues prises en charge pour plus d’informations et pour voir 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

OperatingHoursTimeRange[]

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

OperatingHoursTime

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

OperatingHoursTime

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

PointOfInterestCategorySet[]

Liste des catégories de POI les plus spécifiques
classifications

Classification[]

Tableau de classification
name

string

Nom de la propriété POI
openingHours

OperatingHours

Heures d’ouverture d’un 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

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 None 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.

Nom Type Description
None

string

POI

string

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

Format d’échange de données de notation d’objet JavaScript
xml

string

Langage de balisage extensible

SearchAddressResult

Cet objet est retourné à partir d’un Recherche d’appels réussis.

Nom Type Description
results

SearchAddressResultItem[]

Liste des résultats de l’API Recherche.
summary

SearchSummary

Objet summary pour une réponse d’API Recherche

SearchAddressResultItem

Objet Result pour une réponse d’API Recherche.

Nom Type Description
address

Address

Adresse du résultat
addressRanges

AddressRanges

Décrit la plage d’adresses des deux côtés de la rue pour un résultat de recherche. Les coordonnées des emplacements de début et de fin de la plage d’adresses sont incluses.
dataSources

DataSources

Section facultative. Id de géométrie de référence à utiliser avec l’API 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

GeographicEntityType

Type d’entité Geography. Présente uniquement lorsque entityType a été demandé et est disponible.
entryPoints

EntryPoint[]

Tableau de points d’entrée. Ceux-ci décrivent les types d’entrées disponibles à l’emplacement. Le type peut être « 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

MatchType

Informations sur le type de correspondance.

Valeurs possibles :

  • AddressPoint
  • HouseNumberRange
  • Rue
poi

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.
position

LatLongPairAbbreviated

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

SearchAddressResultType

Valeurs possibles :

  • POI
  • Rue
  • Geography
  • Adresse exacte
  • Plage d’adresses
  • Croisement
viewport

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.

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

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

LatLongPairAbbreviated

Indication lorsque le moteur de recherche interne a appliqué un biais géospatial pour améliorer le classement des résultats. Dans certaines méthodes, cela peut être affecté en définissant les paramètres lat et lon 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

QueryType

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

integer

Nombre total de résultats trouvés.