Requête POST vers le service Geocode
La requête POST vous permet d'envoyer une seule adresse d'entrée ou une liste d'adresses pour le traitement par lots. Il est possible d'indiquer, en option, des préférences de correspondance et/ou de géocodage pour le service Geocode et de recevoir les coordonnées de latitude/longitude associées et des informations de localisation. Les options de préférence d'une requête POST constituent l'ensemble complet d'options disponibles.
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.
Paramètres de requête
- addresses - L'adresse ou les adresses à géocoder. Obligatoire.
- type - Le type de géocode. Facultatif.
- preferences - Les options de correspondance et de géocodage. Facultatif.
- mustMatchMode - Critères de correspondance permettant de déterminer les candidats correspondants optionnels.
- returnFieldsDescriptor - Contrôle le renvoi de données supplémentaires sur un candidat. Facultatif.
Paramètres address
> Série d'adresses des objets Address. La série d'adresses peut contenir une ou plusieurs adresses d'entrée. L'élément addresses est un élément obligatoire.
Paramètre | Type | Description |
---|---|---|
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. |
postCode1 | Chaîne | Le code postal au format approprié pour le pays. Facultatif. |
postCode2 | Chaîne | Extension de code postal au format approprié au 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. |
addressNumber | Chaîne | Numéro de résidence ou de bâtiment. |
streetName | Chaîne | Nom de rue. |
unitType | Chaîne | Spécifie le type d'unité, comme Apt., Ste. et Bât. |
unitValue | Chaîne | Spécifie la valeur/le numéro d'unité, comme « 3B ». |
Paramètres type
L'objet type de type geocodeType a les paramètres suivants. Le paramètre type est facultatif.Paramètre | Type | Description |
---|---|---|
geocodeType | Chaîne |
Indique le type de géocode à effectuer. Facultatif.
|
Paramètres préférence
L'objet preferences de type Preferences se compose des éléments suivants. Les éléments ne sont applicables qu'au service Geocode. L'élément preferences est facultatif.
Pour remplacer la valeur par défaut d'un élément preferences pour un pays en particulier, indiquez la paire clé/valeur dans l'objet customPreferences, avec la constante de clé précédée du code pays ISO-3166 de 3 caractères et d'un point. Par exemple, DEU.fallbackToGeographic
.
Paramètre | Type | Description |
---|---|---|
returnAllCandidateInfo | Booléen | Spécifie s'il faut renvoyer toutes les informations disponibles pour chaque candidat.
|
fallbackToGeographic | 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.
|
fallbackToPostal | 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.
|
FALLBACK_TO_WORLD | Chaîne | Quand XWG est installé, cela indique s'il faut utiliser World Geocoder (XWG) pour définir un géocode lorsqu'aucun géocodeur pays n'est installé ou lorsqu'un géocodeur pays est installé sans jeu de données de géocodage. World Geocoder (XWG) peut renvoyer un géocode postal ou géographique suivant le niveau de prise en charge du jeu de données de géocodage XWG. Facultatif.
|
maxReturnedCandidates | 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 :
|
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 :
|
clientCoordSysName | Chaîne | Spécifie le système de coordonnées que vous souhaitez convertir en géométrie. Le format doit respecter le code European Petroleum Survey Group (EPSG) ou le code SRID. Valeur par défaut = EPSG:4326 . Spécifie le système de référence de coordonnées au format |
customPreferences | Map<String key, String value> | Indique les préférences d'entrée spécifiques au pays. Cet objet peut être utilisé pour indiquer :
Pour remplacer la valeur par défaut pour un pays en particulier, faites précéder la clé constante du code de pays à 3 caractères ISO-3166 et d'un point, puis précisez la valeur. Par exemple, dans une requête XML, une entrée pour un remplacement de pays ressemblerait à ceci :
Les options d'entrée de pays personnalisées sont disponibles pour les pays suivants :
Pour les pays qui prennent en charge les dictionnaires utilisateur personnalisés et les jeux de données de géocodage standard, vous pouvez définir une préférence personnalisée avec la clé KEY_CUSTOM_DICTIONARY_USAGE, qui définit les préférences de recherche et de correspondance lorsque des dictionnaires standard et personnalisés sont disponibles dans le moteur de géocodage. Cette option est uniquement disponible avec le géocodage avant. Pour plus d'informations, reportez-vous à la section Définition des préférences de recherche et de correspondance lors de l'utilisation de dictionnaires standard ou personnalisés. Pour localiser des informations si votre pays prend en charge les dictionnaires utilisateur personnalisés, reportez-vous à la section « Jeux de données de géocodage pris en charge » du pays. Lorsque World Geocoder (XWG) est installé, vous pouvez définir une préférence personnalisée appelée FALLBACK_TO_WORLD. Cette préférence indique s'il faut utiliser XWG pour définir un géocode lorsqu'aucun géocodeur pays n'est installé ou lorsqu'un géocodeur pays est installé sans jeu de données de géocodage. XWG peut renvoyer un géocode postal ou géographique suivant le niveau de prise en charge du jeu de données de géocodage XWG. Facultatif.
|
preferredDictionaryOrder | List<String> | Indique l'ordre de recherche des dictionnaires lorsque plusieurs dictionnaires sont installés. L'ordre de recherche par défaut est l'ordre dans lequel les dictionnaires sont configurés. |
Paramètre mustMatchFields
L'objet mustMatchFields de type FieldsMatching permet de définir les critères de correspondance pour déterminer les candidats correspondants. Pour activer ces options, vous devez définir le champ matchMode sur Custom.
Pour remplacer la valeur par défaut d'un élément mustMatchFields pour un pays en particulier, indiquez la paire clé/valeur dans l'objet customPreferences, avec la constante de clé précédée du code pays ISO-3166 de 3 caractères et d'un point. Par exemple, CAN.matchOnAddressNumber
.
Paramètre | Type | Description |
---|---|---|
matchOnAddressNumber | Booléen |
|
matchOnPostCode1 | Booléen |
|
matchOnAreaName1 | Booléen |
|
matchOnAreaName2 | Booléen |
Remarque : Cette option n'est pas prise en charge par les États-Unis.
|
matchOnAreaName3 | Booléen |
|
matchOnAreaName4 | Booléen |
|
matchOnAllStreetFields | Booléen |
|
mustMatchInput | Booléen |
|
returnFieldsDescriptor
L'objet returnFieldsDescriptor de type returnFieldsDescriptor contrôle le renvoi de données supplémentaires sur un candidat. Par défaut, les informations de candidat étendues ne sont pas renvoyées, mais, dans les cas où des informations supplémentaires sont disponibles, cette fonction peut être contrôlée comme suit :
Pour remplacer la valeur par défaut d'un élément returnFieldsDescriptor pour un pays en particulier, indiquez la paire clé/valeur dans l'objet customPreferences, avec la constante de clé précédée du code pays ISO-3166 de 3 caractères et d'un point. Par exemple, AUS.returnAllCustomFields
.
Paramètre | Type | Description |
---|---|---|
returnAllCustomFields | Booléen |
|
returnedCustomFieldKeys | List<String> | Spécifie une liste de clés qui représentent les champs personnalisés à renvoyer dans la sortie customFields du candidat. Par exemple, « CTYST_KEY » ou « DATATYPE ». Par défaut : viergeRemarque : Pour indiquer différents paires de clé/valeur pour un pays, utilisez des espaces pour séparer les noms des champs personnalisés à renvoyer. Par exemple,
"USA.returnedCustomFieldKeys" : "LAT LON SHORT_CITY" . Les candidats possédant ces informations disponibles incluent les trois champs personnalisés avec ces clés dans la sortie customFields du candidat.Remarque : Les champs personnalisés varient selon le pays. Pour rechercher les informations de votre pays, reportez-vous à la section Informations spécifiques aux pays pour trouver la section correspondante de l'annexe qui fournit davantage de détails.
|
returnMatchDescriptor | Booléen |
|
returnStreetAddressFields | Booléen |
|
returnUnitInformation | Booléen |
|