Champs de sortie
- 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.
Ce tableau décrit les champs de renvoi possibles disponibles pour Geocoding Service. Tous les champs ne sont pas renvoyés avec un candidat correspondant.
Champ | Type | Description |
---|---|---|
totalPossibleCandidates | Entier | Indique le nombre total de candidats possibles. |
totalMatches | Entier | Indique le nombre total de correspondances. |
Objet candidats 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 candidate. Les adresses américaines renvoient 0. 1 Adresse de rue interpolée.2 Point de milieu de 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/de province. 9 Centroïde de comté. 10 Centroïde de ville. 11 Centroïde de localité. 12-15 Réservés pour les é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. |
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. Pour plus d'informations, voir Codes de résultat de géocodage avant. |
objet correspondant de type FieldsMatching, composé d'une série d'un ou de plusieurs candidats correspondants. Contient les éléments suivants : | ||
matchOnAddressNumber | Booléen | Indique si le numéro d'adresse d'entrée correspond au numéro d'adresse du candidat.
|
matchOnPostCode1 | Booléen | Indique si le champ d'entrée postCode1 correspond 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.
|
matchOnAreaName1 | Booléen | Indique si le champ d'entrée areaName1 correspond au champ areaName1 du candidat.
|
matchOnAreaName2 | Booléen | Indique si le champ d'entrée areaName2 correspond au champ areaName2 du candidat.
|
matchOnAreaName3 | Booléen | Indique si le champ d'entrée areaName3 correspond au champ areaName3 du candidat.
|
matchOnAreaName4 | Booléen | Indique si le champ d'entrée areaName4 correspond au champ areaName4 du candidat.
|
matchOnStreetName | Booléen | Indique si le nom de rue d'entrée correspond 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.
|
matchOnStreetDirectional | Booléen | Indique si le cardinal de rue d'entrée correspond 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.
|
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 : | ||
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 | Nom du pays au format Alpha-2 ou Alpha-3 ISO 3166-1, ou nom courant du pays, tel que États-Unis d’Amérique. |
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 ». |
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.
|
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é. |