Requête GET vers le service Geocode
La requête GET vous permet de soumettre une adresse d'entrée et des préférences de correspondance et/ou de géocodage au service Geocode et de recevoir une réponse qui fournit l'objet Candidats contenant les coordonnées de latitude/longitude associées et d'autres informations de correspondance et d'emplacement sur chaque candidat. Les options de préférence d'une requête GET constituent un sous-ensemble du total disponible avec la requête POST.
Base URI
http://<server>:<port>/rest/GlobalGeocode/geocode.[content type]où :
- json
- Le type de contenu par défaut est JSON, sauf s'il est remplacé par une négociation de contenu HTTP.
- xml
- Le type de contenu par défaut est XML, sauf s'il est remplacé par une négociation de contenu HTTP.
Les valeurs [query parameters] sont décrites dans la section suivante. Chaque paire de clé/valeur saisie dans la requête est séparée par une esperluette.
Paramètres de requête
Le tableau suivant définit les paramètres de requête GET du service Geocode. Pour plus d'informations sur la réponse, reportez-vous à la section objet GeocodeServiceResponse.
| Paramètre | Type | Description |
|---|---|---|
|
Remarque : La signification, les valeurs valides et la prise en charge des éléments d'adresse suivants varient selon le pays :
En outre, il existe certaines options de correspondance et de géocodage qui varient selon le pays. Il est important de vérifier les informations spécifiques à votre/vos pays. Pour trouver les informations de votre pays, reportez-vous aux sections informations spécifiques au pays de l'annexe. |
||
| placeName | Chaîne | Nom de bâtiment, nom de lieu, point d'intérêt (POI), nom d'entreprise ou de société associés à l'adresse d'entrée. Facultatif. Par exemple : Pitney Bowes |
| mainAddress | Chaîne | Entrée sur une seule ligne : si aucun autre champ n'est renseigné, l'entrée mainAddress est traitée comme une entrée sur une seule ligne et peut être une collection d'éléments de champs d'adresse. L'ordre d'entrée des champs d'adresse doit refléter la mise en forme d'adresse normale de votre pays. Facultatif. Par exemple : 4750 Walnut St., Boulder CO, 80301 Adresse de rue : si les champs d'adresse (placeName, lastLine, postalCode, etc.) sont fournis séparément, le contenu de ce champ est traité comme la partie de l'adresse de rue et peut inclure le nom de société, le numéro de résidence, les noms de bâtiment et les noms de rue. Facultatif. Entrée d'intersection de rues : pour saisir une intersection, spécifiez les deux noms de rue séparés par une double esperluette (&&). |
| lastLine | Chaîne | Dernière ligne de l'adresse. Facultatif. |
| areaName1 | Chaîne | Spécifie la plus grande zone géographique, en général, un état ou une province. Facultatif. |
| areaName2 | Chaîne | Spécifie la zone géographique secondaire, généralement un comté ou un district. Facultatif. |
| areaName3 | Chaîne | Indique un nom de ville ou d'agglomération. Facultatif. |
| areaName4 | Chaîne | Indique une localité ou une sous-division de ville. Facultatif. |
| postalCode | Chaîne | Le code postal au format approprié pour le pays. Facultatif. |
| country | Chaîne | Code pays ISO 3166-1 alpha-3. Obligatoire. Pour connaître les codes pays, reportez-vous à la section Liste de référence de pays et codes de pays ISO 3166-1. |
| matchMode | Chaîne | Les modes de correspondance déterminent la tolérance utilisée pour effectuer une correspondance entre l'adresse d'entrée et les données de référence. Sélectionnez un mode de correspondance en fonction de la qualité de votre entrée et de la sortie de votre choix. Les modes de correspondance suivants sont disponibles :
|
| fallbackGeo | Booléen | Spécifie sil faut ou non tenter de déterminer un centroïde de région géographique lorsqu'un niveau d'adresse de géocode ne peut être déterminé. Facultatif.
|
| fallbackPostal | Booléen | Spécifie s'il faut ou non tenter de déterminer un centroïde de code postal lorsqu'un géocode au niveau de l'adresse ne peut pas être déterminé. Facultatif.
|
| maxCands | Entier | Nombre maximal de candidats à renvoyer. Facultatif. Il doit s'agir d'une valeur entière. Valeur par défaut = 1. |
| streetOffset | Double | Indique la distance de décalage par rapport au segment de rue à utiliser dans le géocodage de niveau d'adresse. La distance est indiquée dans les unités spécifiées dans l'option streetOffsetUnits. Valeur par défaut = 7 mètres. La distance de décalage est utilisée dans le géocodage de niveau de rue pour éviter le géocodage au milieu d'une rue. Il compense le fait que le géocodage de niveau de rue renvoie un point de latitude et longitude au centre de la rue où se trouve l'adresse. Puisque le bâtiment représenté par une adresse n'est pas dans la rue elle-même, vous ne voulez pas le géocode d'un point dans la rue. Au lieu de cela, vous souhaitez le géocode pour représenter l'emplacement de l'immeuble situé à côté de la rue. Par exemple, un décalage de 50 pieds signifie que le géocode représentera un point de 50 pieds en arrière depuis le centre de la rue. La distance calculée est perpendiculaire à la partie du segment de la rue pour l'adresse. Le décalage est également utilisé pour éviter que les adresses situées l'une en face de l'autre dans la rue n'aient le même point. Le schéma suivant représente un point de décalage par rapport au point d'origine.  |
| streetOffsetUnits | Chaîne | Spécifie l'unité de mesure de décalage d'une rue. L'un des éléments suivants :
|
| cornerOffset | Double | Spécifie la distance pour décaler les extrémités dans la correspondance de niveau de rue. La distance est indiquée dans les unités spécifiées dans l'option cornerOffsetUnits. Cette valeur est utilisée pour éviter que les adresses aux angles de rue ne reçoivent le même géocode que celui de l'intersection. Définit la position de décalage du point géocodé par rapport à l'angle. Valeur par défaut = 7 mètres. Le schéma suivant compare les points d'extrémité d'une rue aux points de décalage.  |
| cornerOffsetUnits | Chaîne | Spécifie l'unité de mesure du décalage d'une rue. L'un des éléments suivants :
|