Partager via

Search - Get Geocoding

  • Référence
Service:
Maps
Version d'API:
2023-06-01

Permet d’obtenir les coordonnées de longitude et de latitude d’une adresse ou d’un nom de lieu.

L’API Get Geocoding est une requête HTTP GET qui retourne les coordonnées longitude et latitude de l’emplacement recherché.

Dans de nombreux cas, le service de recherche complet peut être trop important, par exemple si vous êtes uniquement intéressé par le géocodage traditionnel. La recherche est également accessible exclusivement pour la recherche d’adresse. Le géocodage est effectué en appuyant sur le point de terminaison de géocodage avec uniquement l’adresse ou l’adresse partielle en question. L’index de recherche de géocodage sera interrogé pour tout ce qui se trouve au-dessus des données au niveau de la rue. Aucun point d’intérêt (POI) n’est retourné. Notez que le géocodeur est très tolérant aux fautes de frappe et aux adresses incomplètes. Il s’occupera également de tout, des adresses exactes des rues ou des intersections, ainsi que des zones géographiques de niveau supérieur telles que les centres-villes, les comtés et les États. La réponse retourne également des propriétés d’adresse détaillées telles que la rue, le code postal, la municipalité et les informations sur le pays/la région.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01
Avec des paramètres facultatifs: 
GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
 query True

string

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

string

Ligne de rue officielle d’une adresse relative à la zone, comme spécifié par la localité, ou postalCode, propriétés. L’utilisation classique de cet élément serait de fournir une adresse postale ou une adresse officielle.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
adminDistrict
 query

string

Partie de subdivision de pays d’une adresse, telle que WA.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
adminDistrict2
 query

string

Le comté pour l’adresse structurée, comme King.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
adminDistrict3
 query

string

Zone nommée de l’adresse structurée.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
bbox
 query

number[]

Zone rectangulaire sur la terre définie comme un objet de cadre englobant. Les côtés des rectangles sont définis par des valeurs de longitude et de latitude. Lorsque vous spécifiez ce paramètre, la zone géographique est prise en compte lors du calcul des résultats d’une requête d’emplacement.

Exemple : lon1,lat1,lon2,lat2
coordinates
 query

number[]

Point sur la terre spécifié sous forme de longitude et de latitude. Lorsque vous spécifiez ce paramètre, l’emplacement de l’utilisateur est pris en compte et les résultats retournés peuvent être plus pertinents pour l’utilisateur. Exemple : &coordinates=lon,lat
countryRegion
 query

string

Signal pour le résultat du géocodage vers un code de région/pays ISO 3166-1 Alpha-2 spécifié, par exemple FR./

Si la requête est donnée, ne doit pas utiliser ce paramètre.
locality
 query

string

Partie locale d’une adresse, comme Seattle.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
postalCode
 query

string

Partie du code postal d’une adresse.

Si la requête est donnée, ne doit pas utiliser ce paramètre.
query
 query

string

Chaîne qui contient des informations sur un emplacement, comme une adresse ou un nom de point de repère.
top
 query

integer

int32

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 5, minimum : 1 et maximum : 20.
view
 query

string

Chaîne qui représente un code de région/pays ISO 3166-1 Alpha-2. Cela modifie les frontières et les étiquettes géopolitiques contestées pour s’aligner sur la région d’utilisateur spécifiée. Par défaut, le paramètre View est défini sur « Auto », même si vous ne l’avez pas défini dans la requête.

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

En-tête de la demande

Nom Obligatoire Type Description
Accept-Language

string

Langue dans laquelle les résultats de la recherche doivent être retournés.

Pour plus d’informations, consultez Langues prises en charge .
x-ms-client-id

string

Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. 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 la sécurité Azure AD dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom Type Description
200 OK

GeocodingResponse

Ok

Media Types: "application/geo+json"

En-têtes

x-ms-request-id: string
Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Media Types: "application/geo+json"

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 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 aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. 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 aux API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.
  • Authorization URL est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra.
  • Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
  • L’utilisation du KIT de développement logiciel (SDK) web Azure Maps permet d’configurer une application en fonction de la configuration pour plusieurs cas d’usage.
  • Pour plus d’informations sur la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.

Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, celles-ci peuvent actuellement être traitées comme des clés principales du compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès de serveur à serveur des API REST Azure Maps, où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: header

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Search detail address 15127 NE 24th Street, Redmond, WA
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Search detail address 15127 NE 24th Street, Redmond, WA by query
Search landmark Empire State Building by query

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

Exemple de requête

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Exemple de réponse

Code d’état:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Exemple de requête

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Exemple de réponse

Code d’état:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "Medium",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search detail address 15127 NE 24th Street, Redmond, WA by query

Exemple de requête

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=15127 NE 24th Street Redmond WA

Exemple de réponse

Code d’état:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "WA"
            },
            {
              "shortName": "King County"
            }
          ],
          "formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
          "locality": "Redmond",
          "postalCode": "98052",
          "addressLine": "15127 NE 24th St"
        },
        "type": "Address",
        "confidence": "High",
        "matchCodes": [
          "Good"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.138681,
                47.630358
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          },
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -122.1386787,
                47.6302179
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Route"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.138681,
          47.630358
        ]
      },
      "bbox": [
        -122.14632282407,
        47.626495282429325,
        -122.13103917593001,
        47.63422071757068
      ]
    }
  ]
}

Search landmark Empire State Building by query

Exemple de requête

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=empire state building

Exemple de réponse

Code d’état:
200 
Content-Type: application/geo+json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "New York"
        },
        "type": "PointOfInterest",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98580932617188,
                40.748435974121094
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98580932617188,
          40.748435974121094
        ]
      },
      "bbox": [
        -73.98590850830078,
        40.74833679199219,
        -73.98571014404297,
        40.74853515625
      ]
    },
    {
      "type": "Feature",
      "properties": {
        "address": {
          "countryRegion": {
            "name": "United States"
          },
          "adminDistricts": [
            {
              "shortName": "NY"
            },
            {
              "shortName": "New York County"
            }
          ],
          "formattedAddress": "Empire State Building, NY",
          "locality": "Manhattan"
        },
        "type": "LandmarkBuilding",
        "confidence": "High",
        "matchCodes": [
          "Ambiguous"
        ],
        "geocodePoints": [
          {
            "geometry": {
              "type": "Point",
              "coordinates": [
                -73.98500061035156,
                40.74815368652344
              ]
            },
            "calculationMethod": "Rooftop",
            "usageTypes": [
              "Display"
            ]
          }
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -73.98500061035156,
          40.74815368652344
        ]
      },
      "bbox": [
        -73.98710632324219,
        40.747314453125,
        -73.98412322998047,
        40.74958038330078
      ]
    }
  ]
}

Définitions

Nom Description
Address

Adresse du résultat
AdminDistricts

Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région.
CalculationMethodEnum

Méthode utilisée pour calculer le point de géocode.
ConfidenceEnum

Niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance.

La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et de l’emplacement de l’utilisateur, le cas échéant.
CountryRegion
ErrorAdditionalInfo

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

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
FeatureCollectionEnum

Le type d’un objet FeatureCollection doit être FeatureCollection.
FeaturesItem
FeatureTypeEnum

Le type d’une fonctionnalité doit être Fonctionnalité.
GeocodePoints

Collection de points de géocode qui diffèrent par leur mode de calcul et leur utilisation suggérée.
GeocodingResponse

Cet objet est retourné à partir d’un appel de géocodage réussi
GeoJsonPoint

Type de géométrie valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .
Intersection

Adresse du résultat.
MatchCodesEnum

Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement dans la réponse.

Par exemple, un emplacement géocodé avec les codes de correspondance de Good et Ambiguous signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocode n’avait pas de recherche dans la hiérarchie supérieure pour trouver une correspondance.

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’il n’est pas possible de trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouver plusieurs correspondances à ce niveau. Un exemple de Ambiguous résultat et UpHierarchy est lorsque vous fournissez des informations d’adresse complètes, mais le service de géocode ne peut pas localiser une correspondance pour l’adresse postale et retourne plutôt des informations pour plusieurs valeurs RoadBlock.

Les valeurs possibles sont les suivantes :

Good: l’emplacement n’a qu’une seule correspondance ou toutes les correspondances retournées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York retourne plusieurs bonnes correspondances.

Ambiguous: l’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse de rue 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’option à choisir.

UpHierarchy: l’emplacement représente un déplacement vers le haut de la hiérarchie géographique. Cela se produit lorsqu’une correspondance pour la demande d’emplacement n’a pas été trouvée, de sorte qu’un résultat moins précis est retourné. Par exemple, si une correspondance pour l’adresse demandée est introuvable, un code de correspondance de UpHierarchy avec un type d’entité RoadBlock peut être retourné.
Properties
UsageTypeEnum

Meilleure utilisation pour le point de géocode. Chaque point de géocode est défini en tant que Route point, point Display ou les deux. Utilisez des Route points si vous créez un itinéraire vers l’emplacement. Utilisez des Display points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un Route point peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un Display point peut être un point qui spécifie le centre du parc.

Address

Adresse du résultat

Nom Type Description
addressLine

string

AddressLine qui comprend le nom de la rue et le numéro
adminDistricts

AdminDistricts[]

Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région.
countryRegion

CountryRegion

formattedAddress

string

Propriété Adresse mise en forme
intersection

Intersection

Adresse du résultat.
locality

string

locality, propriété
neighborhood

string

propriété de voisinage
postalCode

string

Propriété Code postal

AdminDistricts

Nom de la subdivision dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la subdivision administrative de premier ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième subdivision d’un pays, d’une dépendance ou d’une région.

Nom Type Description
name

string

Nom du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom complet de l’état tel que Washington, For adminDistrict[1], il peut s’agir du nom complet du comté
shortName

string

Nom court du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir d’un nom court d’état, tel que WA, For adminDistrict[1], il peut s’agir du nom court du comté

CalculationMethodEnum

Méthode utilisée pour calculer le point de géocode.

Nom Type Description
Interpolation

string

Le point de géocode a été mis en correspondance avec un point sur une route à l’aide de l’interpolation.
InterpolationOffset

string

Le point de géocode a été mis en correspondance avec un point sur une route à l’aide de l’interpolation avec un décalage supplémentaire pour déplacer le point sur le côté de la rue.
Parcel

string

Le point de géocode a été mis en correspondance au centre d’un colis.
Rooftop

string

Le point de géocode a été mis en correspondance avec le toit d’un bâtiment.

ConfidenceEnum

Niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance.

La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et de l’emplacement de l’utilisateur, le cas échéant.

Nom Type Description
High

string

Si la confiance est définie sur High, une ou plusieurs correspondances fortes ont été trouvées. Les correspondances de confiance multiples High sont triées dans l’ordre classé par importance, le cas échéant. Par exemple, les points de repère ont de l’importance, mais pas les adresses.

Si une demande inclut un emplacement ou une vue, le classement peut changer de manière appropriée. Par exemple, une requête d’emplacement pour « Paris » retourne « Paris, France » et « Paris, TX » en toute High confiance. « Paris, France » est toujours classé en premier en raison de l’importance, sauf si l’emplacement de l’utilisateur indique que l’utilisateur se trouve dans ou très près de Paris, TX ou si la vue cartographique indique que l’utilisateur effectue une recherche dans cette zone.
Low

string

Medium

string

Dans certains cas, la correspondance retournée peut ne pas être au même niveau que les informations fournies dans la demande. Par exemple, une demande peut spécifier des informations d’adresse et le service de géocode peut uniquement correspondre à un code postal. Dans ce cas, si le service de géocode a l’assurance que le code postal correspond aux Medium données, la confiance est définie sur et le code de correspondance est défini sur UpHierarchy pour spécifier qu’il ne pouvait pas correspondre à toutes les informations et qu’il devait rechercher dans la hiérarchie.

Si les informations d’emplacement dans la requête sont ambiguës et qu’il n’existe aucune information supplémentaire pour classer les emplacements (par exemple, l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), la confiance est définie sur Medium. Par exemple, une requête d’emplacement pour « 148e Ave, Bellevue » peut renvoyer « 148th Ave SE » et « 148th Ave NE » en toute Medium confiance.

Si les informations d’emplacement dans la requête ne fournissent pas suffisamment d’informations pour géocoder un emplacement spécifique, une valeur d’emplacement moins précise peut être retournée et la confiance est définie sur Medium. Par exemple, si une adresse est fournie, mais qu’une correspondance n’est pas trouvée pour le numéro de maison, le résultat du géocodage avec un type d’entité Roadblock peut être retourné.

CountryRegion

Nom Type Description
ISO

string

ISO du pays/région
name

string

nom du pays/de la région

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.

FeatureCollectionEnum

Le type d’un objet FeatureCollection doit être FeatureCollection.

Nom Type Description
FeatureCollection

string

FeaturesItem

Nom Type Description
bbox

number[]

Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, consultez RFC 7946 .
geometry

GeoJsonPoint

Type de géométrie valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .
id

string

ID pour la fonctionnalité retournée
properties

Properties

type

FeatureTypeEnum

Le type d’une fonctionnalité doit être Fonctionnalité.

FeatureTypeEnum

Le type d’une fonctionnalité doit être Fonctionnalité.

Nom Type Description
Feature

string

GeocodePoints

Collection de points de géocode qui diffèrent par leur mode de calcul et leur utilisation suggérée.

Nom Type Description
calculationMethod

CalculationMethodEnum

Méthode utilisée pour calculer le point de géocode.
geometry

GeoJsonPoint

Type de géométrie valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .
usageTypes

UsageTypeEnum[]

Meilleure utilisation pour le point de géocode. Chaque point de géocode est défini en tant que Route point, point Display ou les deux. Utilisez des Route points si vous créez un itinéraire vers l’emplacement. Utilisez des Display points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un Route point peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un Display point peut être un point qui spécifie le centre du parc.

GeocodingResponse

Cet objet est retourné à partir d’un appel de géocodage réussi

Nom Type Description
features

FeaturesItem[]

nextLink

string

est le lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, non ce champ.
type

FeatureCollectionEnum

Le type d’un objet FeatureCollection doit être FeatureCollection.

GeoJsonPoint

Type de géométrie valide GeoJSON Point . Pour plus d’informations, consultez RFC 7946 .

Nom Type Description
bbox

number[]

Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, consultez RFC 7946 .
coordinates

number[]

Un Position est un tableau de nombres avec au moins deux éléments. Les deux premiers éléments sont la longitude et la latitude, précisément dans cet ordre. Altitude/Altitude est un troisième élément facultatif. Pour plus d’informations, consultez RFC 7946 .
type string:

Point

Spécifie le type GeoJSON. Doit être l’un des neuf types d’objets GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature et FeatureCollection.

Intersection

Adresse du résultat.

Nom Type Description
baseStreet

string

Rue principale de l’emplacement.
displayName

string

Nom complet de l’intersection.
intersectionType

string

Type d’intersection.
secondaryStreet1

string

La première rue qui se croise.
secondaryStreet2

string

Le cas échéant, la deuxième rue qui se croise.

MatchCodesEnum

Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement dans la réponse.

Par exemple, un emplacement géocodé avec les codes de correspondance de Good et Ambiguous signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocode n’avait pas de recherche dans la hiérarchie supérieure pour trouver une correspondance.

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’il n’est pas possible de trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouver plusieurs correspondances à ce niveau. Un exemple de Ambiguous résultat et UpHierarchy est lorsque vous fournissez des informations d’adresse complètes, mais le service de géocode ne peut pas localiser une correspondance pour l’adresse postale et retourne plutôt des informations pour plusieurs valeurs RoadBlock.

Les valeurs possibles sont les suivantes :

Good: l’emplacement n’a qu’une seule correspondance ou toutes les correspondances retournées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York retourne plusieurs bonnes correspondances.

Ambiguous: l’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse de rue 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’option à choisir.

UpHierarchy: l’emplacement représente un déplacement vers le haut de la hiérarchie géographique. Cela se produit lorsqu’une correspondance pour la demande d’emplacement n’a pas été trouvée, de sorte qu’un résultat moins précis est retourné. Par exemple, si une correspondance pour l’adresse demandée est introuvable, un code de correspondance de UpHierarchy avec un type d’entité RoadBlock peut être retourné.

Nom Type Description
Ambiguous

string

Good

string

UpHierarchy

string

Properties

Nom Type Description
address

Address

Adresse du résultat
confidence

ConfidenceEnum

Niveau de confiance que le résultat de l’emplacement géocodé est une correspondance. Utilisez cette valeur avec le code de correspondance pour déterminer des informations plus complètes sur la correspondance.

La confiance d’un emplacement géocodé est basée sur de nombreux facteurs, notamment l’importance relative de l’emplacement géocodé et de l’emplacement de l’utilisateur, le cas échéant.
geocodePoints

GeocodePoints[]

Collection de points de géocode qui diffèrent par leur mode de calcul et leur utilisation suggérée.
matchCodes

MatchCodesEnum[]

Une ou plusieurs valeurs de code de correspondance qui représentent le niveau de géocodage pour chaque emplacement dans la réponse.

Par exemple, un emplacement géocodé avec les codes de correspondance de Good et Ambiguous signifie que plusieurs emplacements de géocodage ont été trouvés pour les informations d’emplacement et que le service de géocode n’avait pas de recherche dans la hiérarchie supérieure pour trouver une correspondance.

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’il n’est pas possible de trouver un emplacement de géocodage correspondant à toutes les informations d’emplacement fournies, de sorte que le service de géocode a dû rechercher dans la hiérarchie supérieure et trouver plusieurs correspondances à ce niveau. Un exemple de Ambiguous résultat et UpHierarchy est lorsque vous fournissez des informations d’adresse complètes, mais le service de géocode ne peut pas localiser une correspondance pour l’adresse postale et retourne plutôt des informations pour plusieurs valeurs RoadBlock.

Les valeurs possibles sont les suivantes :

Good: l’emplacement n’a qu’une seule correspondance ou toutes les correspondances retournées sont considérées comme des correspondances fortes. Par exemple, une requête pour New York retourne plusieurs bonnes correspondances.

Ambiguous: l’emplacement est l’un des ensembles de correspondances possibles. Par exemple, lorsque vous interrogez l’adresse de rue 128 Main St., la réponse peut renvoyer deux emplacements pour 128 North Main St. et 128 South Main St. parce qu’il n’y a pas suffisamment d’informations pour déterminer l’option à choisir.

UpHierarchy: l’emplacement représente un déplacement vers le haut de la hiérarchie géographique. Cela se produit lorsqu’une correspondance pour la demande d’emplacement n’a pas été trouvée, de sorte qu’un résultat moins précis est retourné. Par exemple, si une correspondance pour l’adresse demandée est introuvable, un code de correspondance de UpHierarchy avec un type d’entité RoadBlock peut être retourné.
type

string

Valeurs possibles :

  • Adresse
  • Barrage routier
  • RoadIntersection
  • Voisinage
  • PopulatedPlace
  • Code postal1
  • AdminDivision1
  • AdminDivision2
  • CountryRegion

UsageTypeEnum

Meilleure utilisation pour le point de géocode. Chaque point de géocode est défini en tant que Route point, point Display ou les deux. Utilisez des Route points si vous créez un itinéraire vers l’emplacement. Utilisez des Display points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un Route point peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un Display point peut être un point qui spécifie le centre du parc.

Nom Type Description
Display

string

Route

string