objet GeocodeServiceResponse
- 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.
Votre nom | Type | Description |
---|---|---|
totalPossibleCandidates | Entier | Indique le nombre total de candidats possibles. |
totalMatches | Entier | Indique le nombre total de correspondances. |
candidats : 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 candidate. 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.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 : Les catégories de correspondance possibles sont les suivantes : Z1 Correspondance postale avec le centroïde 1 de code postal.Z2 Postal match with partial post code 2 centroid. Z3 Correspondance postale avec le centroïde 2 de code postal.G1 Geographic match with area name 1 centroid. G2 Correspondance géographique avec le centroïde 2 de nom de zone.G3 Geographic match with area name 3 centroid. 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 Match point located at the house level that has been projected from the nearest segment. S0 Aucune coordonnée n'est disponible, mais des parties de l'adresse peuvent correspondre à la source de données.S4 The geocode is located at a street centroid S5 Le géocode est situé à une adresse de rue.S7 The geocode is located at a street address that has been interpolated between point house locations. S8 Correspondance de point située à l'emplacement de résidence.Des informations de correspondance supplémentaires sont fournies au format P Street prefix direction. N Nom de rue.T Street type. S Direction du suffixe de rue.C City name. Z Code postal.A Geocoding dataset. U Jeu de données 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 The input address number matched the candidate's address number. 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 The input postCode1 matched the candidate's postCode1. 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 The input postCode2 matched the candidate's postCode2. False The input postCode2 did not match candidate's postCode2 |
matchOnAreaName1 | Booléen | Indique si le champ d'entrée areaName1 correspond au champ areaName1 du candidat. True The input areaName1 matched the candidate's areaName1. False The input areaName1 did not match the candidate's areaName1. |
matchOnAreaName2 | Booléen | Indique si le champ d'entrée areaName2 correspond au champ areaName2 du candidat. True The input areaName2 matched the candidate's areaName2. False The input areaName2 did not match the candidate's areaName2. |
matchOnAreaName3 | Booléen | Indique si le champ d'entrée areaName3 correspond au champ areaName3 du candidat. True The input areaName3 matched the candidate's areaName3. False The input areaName3 did not match the candidate's areaName3. |
matchOnAreaName4 | Booléen | Indique si le champ d'entrée areaName4 correspond au champ areaName4 du candidat. True The input areaName4 matched the candidate's areaName4. False The input areaName4 did not match the candidate's areaName4. |
matchOnCountry | Booléen | Indique si le pays candidat correspond au pays d'entrée. True The candidate country matches the input country. False The candidate country does not match the input country. |
matchOnAllStreetFields | Booléen | Indique si tous les champs de rue en entrée correspondent à tous les champs de rue du candidat. True All of the input street fields matched all of the candidate's street fields. False One or more of the input street fields do not match the candidate's street fields. |
matchOnStreetName | Booléen | Indique si le nom de rue d'entrée correspond au nom de rue du candidat. True The input street name matched the candidate's street name. False The input street name did not match the candidate's street name. |
matchOnStreetType | Booléen | Indique si le type de rue d'entrée correspond au type de rue du candidat. True The input street type matched the candidate's street type. False The input street type did not match the candidate's street type. |
matchOnStreetDirectional | Booléen | Indique si le cardinal de rue d'entrée correspond au cardinal de rue du candidat. True The input street directional matched the candidate's street directional. False The input street directional did not match the candidate's street directional. |
matchOnPlaceName | Booléen | Indique si le nom de lieu d'entrée correspond au nom de lieu du candidat. True The input place name matched the candidate's place name. False The input place name did not match the candidate's place name. |
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 | Pays |
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. |
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 The range is on the left side of the street. RIGHT The range is on the right side of the street. BOTH The range is on both the left and right side of the street. UNKNOWN No information is available on the side of the street this range is located. |
oddEvenIndicator | Chaîne | Fournit des informations sur la numérotation des résidences de la plage du candidat. ODD The range contains odd house numbers. EVEN The range contains even house numbers. BOTH The range contains both odd and even house numbers. IRREGULAR The range contains both even and odd numbers in an irregular order. UNKNOWN No information is available on the odd/even house numbering on this range. |
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é. |
totalPossibleCandidates | Entier | Indique combien de candidats correspondants ont été trouvés. |