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]
Paramètres de requête
- addresses - L'adresse ou les adresses à géocoder. Série d'adresses des objets Address. La série d'adresses peut contenir une ou plusieurs adresses d'entrée. Obligatoire.
- type - Le type de géocode. Facultatif. Le paramètre type est 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ètre | Type | Description |
---|---|---|
POST: type GET: geocodeType |
Chaîne |
Indique le type de géocode à effectuer. Facultatif.
|
POST: returnAllCandidateInfo |
Booléen | Spécifie s'il faut renvoyer toutes les informations disponibles pour chaque candidat.
|
POST: fallbackToGeographic GET: fallbackGeo |
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.
|
POST: fallbackToPostal GET: fallbackPostal |
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.
|
POST: maxReturnedCandidates GET: maxCands |
Entier | Nombre maximal de candidats à renvoyer. Facultatif. Il doit s'agir d'une valeur entière. Valeur par défaut = 1. |
streetOffset | Double | Distance de décalage des segments de rue La distance est indiquée dans les unités spécifiées dans la préférence 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. 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. |
streetOffsetUnits | Chaîne | Unité de mesure du décalage de rue. Un des éléments suivants : Pieds, Mètres (par défaut). |
cornerOffset | Double | Distance pour décaler les points d'extrémité de rue dans la correspondance au niveau de la rue. La distance est indiquée dans les unités spécifiées dans la préférence 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 | Unité de mesure du décalage de rue. Un des éléments suivants : Pieds, Mètres (par défaut). |
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 :
|
maxRanges | Entier | Une plage est une série d'adresse avec un segment de rue. Par exemple, 5400-5499 Main St. est une plage d'adresses représentant des adresses du bloc 5400 de Main St. Une plage peut représenter juste des adresses paires et/ou impaires au sein d'un segment. Une plage peut également représenter un bâtiment unique doté de plusieurs unités, tel qu'une résidence d'appartements. Cette option indique le nombre maximal de plages à renvoyer pour chaque candidat. Dans la mesure où le géocodeur renvoie un candidat par segment et où un segment peut contenir plusieurs plages, cette option vous permet de voir les autres plages d'un segment de candidat. Il doit s'agir d'une valeur entière. Valeur par défaut = 0. |
maxRangeUnits | Entier | Cette option indique le nombre maximal d'unités (par exemple, des appartements ou des suites) à renvoyer pour chaque plage. Par exemple, pour géocoder un immeuble de bureaux au 65 Main St. contenant quatre suites, un maximum de quatre unités sont renvoyées pour la plage de l'immeuble (65 Suite 1, 65 Suite 2, 65 Suite 3 et 65 Suite 4). Si vous aviez indiqué un nombre maximal d'unités de 2, seules deux unités auraient été renvoyées au lieu des quatre. Il doit s'agir d'une valeur entière. Valeur par défaut = 0. |
POST: 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 |
POST: matchOnAddressNumber |
Booléen |
|
POST: matchOnPostCode1 |
Booléen |
|
POST: matchOnPostCode2 |
Booléen |
|
POST: matchOnAreaName1 |
Booléen |
|
POST: matchOnAreaName2 |
Booléen |
Remarque : Cette option n'est pas prise en charge par les États-Unis.
|
POST: matchOnAreaName3 |
Booléen |
|
POST: matchOnAreaName4 |
Booléen |
|
POST: matchOnAllStreetFields |
Booléen |
|
POST: returnAllCustomFields |
Booléen |
|
POST: returnedCustomFieldKeys |
List<String> | Spécifie une liste de clés qui représentent les champs personnalisés à renvoyer dans la sortie customFields du candidat. Pour indiquer différents paires de clé/valeur pour un pays, utilisez des espaces pour séparer les noms des champs personnalisés à renvoyer. Les champs personnalisés varient selon le pays. Par exemple, « CTYST_KEY » ou « DATATYPE ». Par défaut : vierge |
POST: returnMatchDescriptor |
Booléen |
|
POST: returnStreetAddressFields |
Booléen |
|
POST: returnUnitInformation |
Booléen |
|