objet GeocodeServiceResponse

Une requête auprès du service Geocode renvoie un objet GeocodeServiceResponse qui contient les éléments suivants :
  • totalPossibleCandidates — Indique le nombre total de candidats possibles.
  • totalMatches — Indique le nombre total de correspondances.
  • candidates — Répertorie un ou plusieurs candidats correspondant à votre ou à vos adresses d'entrée. Les informations de correspondance et d'emplacement sont renvoyées pour chaque correspondance de candidat.
Nom Type Description
totalPossibleCandidates Entier Indique le nombre total de candidats possibles.
totalMatches Entier Indique le nombre total de correspondances.
candidates Objet de type Candidate, composé d'une série d'un ou de plusieurs candidats correspondants et d'informations d'adresse, de correspondance et d'emplacement associées. Contient les éléments suivants :
precisionLevel Entier Code permettant d'évaluer la précision du géocode. L'un des éléments suivants :
0
Aucune information de coordonnées n'est disponible pour cette adresse du candidat.
1
Adresse postale interpolée.
2
Point de milieu du segment de rue.
3
Centroïde de code postal 1.
4
Centroïde de code postal 2 partiel.
5
Centroïde de code postal 2.
6
Intersection.
7
Point d'intérêt. (Si la base de données contient des données POI.)
8
Centroïde d'État/province.
9
Centroïde de comté.
10
Centroïde de ville.
11
Centroïde de localité
12-15
Réservés aux éléments personnalisés non spécifiés.
16
Le résultat est un point d'adresse.
17
Le résultat a été généré à l'aide de données de points d'adresse pour modifier les données de segment du candidat.
18
Le résultat est un point d'adresse qui a été projeté via la fonction de décalage d'axe. Pour utiliser la fonction de décalage d'axe, vous devez disposer à la fois de la base de données de plages de points et de rues.
Remarque : Ce champ n'est pas renvoyé pour les États-Unis. Pour plus d’informations sur la précision du géocode pour les États-Unis, reportez-vous à la section Codes d'emplacement.
formattedStreetAddress Chaîne

La principale ligne d'adresse formatée.
formattedLocationAddress Chaîne La dernière ligne d'adresse formatée.
identifier Chaîne Pour les candidats de niveau point ou rue, il s'agit généralement de l'ID de segment.
precisionCode Chaîne Code permettant d'évaluer la précision du géocode.

Le format de la chaîne de résultat de géocodage est le suivant : match_category[additional_match_information].

Les catégories de correspondance possibles sont les suivantes :

Z1
Correspondance postale avec le centroïde 1 de code postal.
Z2
Correspondance postale avec le centroïde 2 de code postal partiel.
Z3
Correspondance postale avec le centroïde 3 de code postal.
G1
Correspondance géographique avec le centroïde 1 de nom de zone.
G2
Correspondance géographique avec le centroïde 2 de nom de zone.
G3
Correspondance géographique avec le centroïde 3 de nom de zone.
G4
Correspondance géographique avec le centroïde 4 de nom de zone.

Les correspondances de la série S indiquent que l'enregistrement correspond à un seul candidat d'adresse.

SX
Point situé à une intersection de rue.
SC
Correspondance de point située au niveau résidence qui a été projetée depuis le segment le plus proche.
S0
Aucune coordonnée n'est disponible, mais des parties de l'adresse peuvent correspondre à la source de données.
S4
Le géocode est situé au centroïde de rue.
S5
Le géocode est situé à une adresse de rue.
S7
Le géocode est situé à une adresse de rue qui a été interpolée entre les emplacements de résidence de point.
S8
Correspondance de point située à l'emplacement de résidence.
Des informations de correspondance supplémentaires sont fournies au format HPNTSCSZA. Si un résultat de correspondance n'a pas été obtenu pour le composant spécifié, un trait d'union (-) apparaît à la place d'une lettre.
H
Numéro de la maison.
P
Direction du préfixe de rue.
N
Nom de rue.
T
Type de rue.
S
Direction du suffixe de rue.
C
Nom de ville.
Z
Code postal.
A
Jeu de données de géocodage.
U
Dictionnaire utilisateur personnalisé.
Remarque : Pour plus d’informations, y compris sur les valeurs et les significations spécifiques à chaque pays, reportez-vous à la section Code de résultat globaux.
sourceDictionary Chaîne Identifie le dictionnaire à la source des informations et des données du candidat. Le dictionnaire source est une valeur d'entier basée sur 0 qui indique le dictionnaire configuré dont provient le candidat. Si vous disposez d'un seul dictionnaire, il s'agit toujours de « 0 ».
objet mis en correspondance. Indique les parties de l'entrée mises en correspondance ; composé des éléments suivants :
matchOnAddressNumber Booléen Indique si le numéro d'adresse d'entrée correspond au numéro d'adresse du candidat.
True
Le numéro d'adresse d'entrée correspond au numéro d'adresse du candidat.
False
Le numéro d'adresse d'entrée ne correspond pas au numéro d'adresse du candidat.
matchOnPostCode1 Booléen Indique si le champ d'entrée postCode1 correspond au champ postCode1 du candidat.
True
Le champ d'entrée postCode1 correspond au champ postCode1 du candidat.
False
Le champ d'entrée postCode1 ne correspond pas au champ postCode1 du candidat.
matchOnPostCode2 Booléen Indique si le champ d'entrée postCode2 (extension de code postal) correspond au champ postCode2 du candidat.
True
Le champ d'entrée postCode2 correspond au champ postCode2 du candidat.
False
Le champ d'entrée postCode2 ne correspond pas au champ postCode2 du candidat.
matchOnAreaName1 Booléen Indique si le champ d'entrée areaName1 correspond au champ areaName1 du candidat.
True
Le champ d'entrée areaName1 correspond au champ areaName1 du candidat.
False
Le champ d'entrée areaName1 ne correspond pas au champ areaName1 du candidat.
matchOnAreaName2 Booléen Indique si le champ d'entrée areaName2 correspond au champ areaName2 du candidat.
True
Le champ d'entrée areaName2 correspond au champ areaName2 du candidat.
False
Le champ d'entrée areaName2 ne correspond pas au champ areaName2 du candidat.
matchOnAreaName3 Booléen Indique si le champ d'entrée areaName3 correspond au champ areaName3 du candidat.
True
Le champ d'entrée areaName3 correspond au champ areaName3 du candidat.
False
Le champ d'entrée areaName3 ne correspond pas au champ areaName3 du candidat.
matchOnAreaName4 Booléen Indique si le champ d'entrée areaName4 correspond au champ areaName4 du candidat.
True
Le champ d'entrée areaName4 correspond au champ areaName4 du candidat.
False
Le champ d'entrée areaName4 ne correspond pas au champ areaName4 du candidat.
matchOnStreetName Booléen Indique si le nom de rue d'entrée correspond au nom de rue du candidat.
True
Le nom de rue d'entrée correspond au nom de rue du candidat.
False
Le nom de rue d'entrée ne correspond pas au nom de rue du candidat.
matchOnStreetType Booléen Indique si le type de rue d'entrée correspond au type de rue du candidat.
True
Le type de rue d'entrée correspond au type de rue du candidat.
False
Le type de rue d'entrée ne correspond pas au type de rue du candidat.
matchOnStreetDirectional Booléen Indique si le cardinal de rue d'entrée correspond au cardinal de rue du candidat.
True
Le cardinal de rue d'entrée correspond au cardinal de rue du candidat.
False
Le cardinal de rue d'entrée ne correspond pas au cardinal de rue du candidat.
matchOnPlaceName Booléen Indique si le nom de lieu d'entrée correspond au nom de lieu du candidat.
True
Le nom de lieu d'entrée correspond au nom de lieu du candidat.
False
Le nom de lieu d'entrée ne correspond pas au nom de lieu du candidat.
objet de géométrie. Géocode renvoyé constitué des éléments suivants :
coordinates Double Géocode du candidat, spécifié sous forme de coordonnées x (longitude) et y (latitude) séparées par une virgule.
crs Chaîne Système de référence de coordonnées utilisé pour le géocode du candidat.
type Chaîne Types de géométrie. La valeur de renvoi est toujours Point.
 
objet d'adresse. Adresse de candidat renvoyée pouvant contenir certains des éléments suivants :
Remarque : La signification, les valeurs valides et la prise en charge des éléments d'adresse suivants varient selon le pays :
  • placeName
  • mainAddress
  • lastLine
  • areaName1
  • areaName2
  • areaName3
  • areaName4
  • postCode1
  • postCode2
  • country

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.
mainAddressLine Chaîne Ligne d'adresse de candidat.
addressLastLine Chaîne Dernière ligne d'adresse du candidat.
placeName Chaîne Nom de société, d'entreprise, d'organisation, d'activité ou de bâtiment.
areaName1 Chaîne État, province ou région.
areaName2 Chaîne Comté ou district.
areaName3 Chaîne Ville, agglomération ou banlieue.
areaName4 Chaîne Localité
postCode1 Chaîne Code postal principal.
postCode2 Chaîne Code postal secondaire, s'il existe.
country Chaîne Country
addressNumber Chaîne Numéro de résidence ou de bâtiment.
streetName Chaîne Nom de rue.
unitType Chaîne Type d'unité, comme Apt., Ste. et Bât.
unitValue Chaîne Valeur/Numéro d'unité, comme « 3 B ».
customFields Objet Les champs et les valeurs correspondantes renvoyés varient selon le pays. Voir les sections informations spécifiques au pays de l'annexe.
plages : objet CandidateRange. Contient des informations sur les plages d'un candidat, composées des éléments suivants :
placeName Chaîne Le cas échéant, indique le nom de lieu ou d'immeuble du candidat.
lowHouse Chaîne Indique le numéro de résidence inférieur de la plage de rues du candidat.
highHouse Chaîne Indique le numéro de résidence supérieur de la plage de rues du candidat.
side Chaîne Fournit des informations sur le côté de rue où se trouve la plage du candidat.
LEFT
La plage se trouve du côté gauche de la rue.
RIGHT
La plage se trouve du côté droit de la rue.
BOTH
La plage se trouve des côtés gauche et droit de la rue.
UNKNOWN
Aucune information n'est disponible sur le côté de rue où se trouve cette plage.
oddEvenIndicator Chaîne Fournit des informations sur la numérotation des résidences de la plage du candidat.
ODD
La plage contient des numéros de résidence impairs.
EVEN
La plage contient des numéros de résidence pairs.
BOTH
La plage contient des numéros de résidence pairs et impairs.
IRREGULAR
La plage contient des numéros pairs et impairs dans un ordre irrégulier.
UNKNOWN
Aucune information n'est disponible sur la numérotation paire/impaire des résidences de cette plage.
customValues Carte Carte de valeurs de proximité associées à la plage du candidat.
unités : objet CandidateRangeUnit. Contient des informations sur les unités de plage d'un candidat, composées des éléments suivants :
placeName Chaîne Le cas échéant, indique le nom de lieu ou d'immeuble du candidat.
unitType Chaîne Indique le type d'unité (APT, STE, etc.).
highUnitValue Chaîne Indique le numéro d'unité supérieur de cette unité de plage.
lowUnitValue Chaîne Indique le numéro d'unité inférieur de cette unité de plage.
customValues Carte Carte de valeurs de proximité associées à l'unité.