Partager via

Search - Get Geocoding

Service:
Maps
Version d'API:
2025-01-01

Permet d’obtenir les coordonnées de longitude et de latitude d’une adresse postale ou le nom d’un 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 n’êtes intéressé que par le géocodage traditionnel. Vous pouvez également accéder à la recherche d’adresses exclusivement. 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 tous les éléments 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 gérera également toutes les adresses de rue exactes, les rues ou les intersections ainsi que les zones géographiques de niveau supérieur telles que les centres urbains, les comtés et les états. La réponse retourne également des propriétés d’adresse détaillées telles que les informations de rue, de code postal, de municipalité et de pays/région.

GET https://atlas.microsoft.com/geocode?api-version=2025-01-01
Avec des paramètres facultatifs: 
GET https://atlas.microsoft.com/geocode?api-version=2025-01-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 officielle d’une adresse par rapport à la zone, telle que spécifiée par la localité, ou postalCode, propriétés. L’utilisation classique de cet élément serait de fournir une adresse postale ou toute adresse officielle.

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
adminDistrict
 query

string

La partie sous-division du pays d’une adresse, telle que WA.

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
adminDistrict2
 query

string

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

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
adminDistrict3
 query

string

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

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
bbox
 query

number[]

Une 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 de l’informatique des résultats d’une requête d’emplacement.

Exemple : lon1,lat1,lon2,lat2
coordinates
 query

number[]

Point sur la terre spécifié comme longitude et 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 : coordonnées &=lon,lat
countryRegion
 query

string

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

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
locality
 query

string

Partie localité d’une adresse, telle que Seattle.

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
postalCode
 query

string

Partie du code postal d’une adresse.

Ce paramètre ne doit pas être utilisé lorsqu’il query est inclus dans la demande.
query
 query

string

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

integer (int32)

minimum: 1
maximum: 20

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 une code ISO 3166-1 Alpha-2 région/pays. Cela modifie les bordures et étiquettes contestées géopolitiques pour s’aligner sur la région 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 afficher les vues disponibles.

En-tête de la demande

Nom Obligatoire Type Description
Accept-Language

string

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

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

string

Spécifie le compte destiné à l’utilisation 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 de plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

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 Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

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

Remarque

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

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

Étendues

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

subscription-key

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

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

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès 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, CLI, azure SDK ou LES API REST.

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

Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Search 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=2025-01-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",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "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=2025-01-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",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "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=2025-01-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",
          "streetName": "NE 24th St",
          "streetNumber": "15127",
          "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=2025-01-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 sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.
CalculationMethodEnum

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

Le 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 pour obtenir 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 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 Feature.
GeocodePoints

Collection de points de géocode qui diffèrent de la façon dont ils ont été calculés et de 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 GeoJSON Point valide. Pour plus d’informations, reportez-vous à 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 de la réponse.

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

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’un emplacement de géocode n’a pas pu être trouvé qui correspond à toutes les informations d’emplacement fournies, de sorte que le service géocode devait rechercher dans la hiérarchie et trouver plusieurs correspondances à ce niveau. Un exemple de résultat Ambiguous et UpHierarchy est le cas lorsque vous fournissez des informations d’adresse complètes, mais que 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 retourner deux emplacements pour 128 North Main St. et 128 South Main St. car il n’y a pas suffisamment d’informations pour déterminer quelle 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. Par conséquent, 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 comme un point Route, un point Display ou les deux. Utilisez Route points si vous créez un itinéraire vers l’emplacement. Utilisez Display points si vous affichez l’emplacement sur une carte. Par exemple, si l’emplacement est un parc, un point de Route peut spécifier une entrée au parc où vous pouvez entrer avec une voiture, et un point de Display peut être un point qui spécifie le centre du parc.

Address

Object

Adresse du résultat

Nom Type Description
addressLine

string

AddressLine qui inclut le nom et le numéro de rue
adminDistricts

AdminDistricts[]

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

CountryRegion

formattedAddress

string

Propriété Address mise en forme
intersection

Intersection

Adresse du résultat.
locality

string

localité, propriété
neighborhood

string

propriété de voisinage
postalCode

string

Propriété code postal
streetName

string

Le nom de la rue à partir de formattedAddress
streetNumber

string

Le numéro dans la rue, le cas échéant, à partir de formattedAddress

AdminDistricts

Object

Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou 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

Énumération

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

Valeur Description
Interpolation

Le point de géocodage a été apparié à un point sur une route à l’aide de l’interpolation.
InterpolationOffset

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

Le point de géocodage a été apparié au centre d’une parcelle.
Rooftop

Le point de géocodage a été apparié au toit d’un bâtiment.

ConfidenceEnum

Énumération

Le 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 pour obtenir 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 l’emplacement de l’utilisateur, le cas échéant.

Valeur Description
High

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

Si une demande comprend un lieu ou une vue, le classement peut changer en conséquence. Par exemple, une requête d’emplacement pour « Paris » renvoie « Paris, France » et « Paris, TX » tous deux avec High confiance. « Paris, France » est toujours classé en premier en raison de son importance, sauf si l’emplacement de l’utilisateur indique que l’utilisateur se trouve à Paris, TX ou très proche de Paris, TX ou que la vue de la carte indique que l’utilisateur effectue une recherche dans cette zone.
Medium

Dans certaines situations, la correspondance renvoyé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éocodage peut uniquement correspondre à un code postal. Dans ce cas, si le service de géocodage est sûr que le code postal correspond aux données, la confiance est définie sur Medium et le code de correspondance est défini sur UpHierarchy pour spécifier qu’il n’a pas pu correspondre à toutes les informations et qu’il a dû effectuer une recherche dans la hiérarchie ascendante.

Si les informations d’emplacement de la requête sont ambiguës et qu’il n’existe pas d’informations supplémentaires pour classer les emplacements (telles que l’emplacement de l’utilisateur ou l’importance relative de l’emplacement), le niveau de confiance est défini sur Medium. Par exemple, une requête d’emplacement pour « 148th Ave, Bellevue » peut renvoyer « 148th Ave SE » et « 148th Ave NE », tous deux avec Medium confiance.

Si les informations d’emplacement de 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 renvoyée et le niveau de confiance est défini sur Medium. Par exemple, si une adresse est fournie, mais qu’aucune correspondance n’est trouvée pour le numéro de maison, le résultat du géocodage avec un type d’entité Roadblock peut être renvoyé.
Low

CountryRegion

Object
Nom Type Description
ISO

string

ISO du pays/de la région
name

string

nom du pays/de la région

ErrorAdditionalInfo

Object

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

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

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

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

FeatureCollectionEnum

Énumération

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

Valeur Description
FeatureCollection

FeaturesItem

Object
Nom Type Description
bbox

number[] (double)

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

GeoJsonPoint

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.
id

string

ID de la fonctionnalité retournée
properties

Properties

type

FeatureTypeEnum

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

FeatureTypeEnum

Énumération

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

Valeur Description
Feature

GeocodePoints

Object

Collection de points de géocode qui diffèrent de la façon dont ils ont été calculés et de leur utilisation suggérée.

Nom Type Description
calculationMethod

CalculationMethodEnum

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

GeoJsonPoint

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.
usageTypes

UsageTypeEnum[]

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

GeocodingResponse

Object

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

Nom Type Description
features

FeaturesItem[]

nextLink

string

Il s’agit du lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, aucun champ n’est présent.
type

FeatureCollectionEnum

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

GeoJsonPoint

Object

Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.

Nom Type Description
bbox

number[] (double)

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

number[] (double)

Un Position est un tableau de nombres avec deux éléments ou plus. Les deux premiers éléments sont longitude et latitude, précisément dans cet ordre. altitude/élévation est un troisième élément facultatif. Pour plus d’informations, reportez-vous à 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

Object

Adresse du résultat.

Nom Type Description
baseStreet

string

Rue principale pour l’emplacement.
displayName

string

Nom complet de l’intersection.
intersectionType

string

Type d’intersection.
secondaryStreet1

string

La première rue qui croise.
secondaryStreet2

string

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

MatchCodesEnum

Énumération

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

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

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’un emplacement de géocode n’a pas pu être trouvé qui correspond à toutes les informations d’emplacement fournies, de sorte que le service géocode devait rechercher dans la hiérarchie et trouver plusieurs correspondances à ce niveau. Un exemple de résultat Ambiguous et UpHierarchy est le cas lorsque vous fournissez des informations d’adresse complètes, mais que 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 retourner deux emplacements pour 128 North Main St. et 128 South Main St. car il n’y a pas suffisamment d’informations pour déterminer quelle 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. Par conséquent, 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é.

Valeur Description
Good
Ambiguous
UpHierarchy

Properties

Object
Nom Type Description
address

Address

Adresse du résultat
confidence

ConfidenceEnum

Le 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 pour obtenir 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 l’emplacement de l’utilisateur, le cas échéant.
geocodePoints

GeocodePoints[]

Collection de points de géocode qui diffèrent de la façon dont ils ont été calculés et de 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 de la réponse.

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

De même, un emplacement géocodé avec des codes de correspondance de Ambiguous et UpHierarchy implique qu’un emplacement de géocode n’a pas pu être trouvé qui correspond à toutes les informations d’emplacement fournies, de sorte que le service géocode devait rechercher dans la hiérarchie et trouver plusieurs correspondances à ce niveau. Un exemple de résultat Ambiguous et UpHierarchy est le cas lorsque vous fournissez des informations d’adresse complètes, mais que 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 retourner deux emplacements pour 128 North Main St. et 128 South Main St. car il n’y a pas suffisamment d’informations pour déterminer quelle 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. Par conséquent, 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

L'un des:

  • Adresse
  • Barrage routier
  • RoadIntersection
  • Quartier
  • Remplissage
  • Code postal1
  • AdminDivision1
  • AdminDivision2
  • Pays/Région

UsageTypeEnum

Énumération

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

Valeur Description
Display
Route