objet ReverseGeocodeServiceResponse
Une requête auprès du service Reverse Geocode renvoie un objet GeocodeServiceResponse contenant les éléments suivants :
- totalPossibleCandidates — Indique le nombre total de candidats possibles.
- totalMatches — Indique le nombre total de correspondances.
- Objet candidates — répertorie un ou plusieurs candidats correspondant à votre ou vos coordonnées d'entrée. Des informations de correspondance et d'adresse sont renvoyées pour chaque 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. |
| precisionCode | Chaîne | Code de résultat renvoyé de géocodage inverse renvoyé. Les définitions sont fournies dans l'annexe : Pour les États-Unis, reportez-vous à la section Codes d'emplacement d'adresse ; pour tous les autres pays, reportez-vous à la section Codes de résultat de géocodage inverse (R). |
| 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 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. |