Fonctions d'API REST
Le module inclut les méthodes API REST de contrôle et de personnalisation des paramètres par défaut et des options.
| Méthode REST | Description |
|---|---|
| Data.AddressLine1 | Entrée sur une seule ligne |
| Data.Category | Catégorie de point d'intérêt |
| Data.City | Ville à rechercher. Combinez avec AddressLine1 pour renvoyer les candidats dans votre zone ciblée. |
| Data.Country | Spécifie le pays faisant l'objet de la recherche (code pays ISO de 3 caractères). |
| Data.OriginLatitude | Coordonnée Y de l'origine. |
| Data.OriginLongitude | Coordonnée X de l'origine. |
| Data.PostalCode | Code postal |
| Data.StateProvince | État ou province |
| Option.BBoxEast | Coordonnée définissant la limite à l'Est du cadre de limitation. |
| Option.BBoxNorth | Coordonnée définissant la limite au Nord du cadre de limitation. |
| Option.BBoxSouth | Coordonnée définissant la limite au Sud du cadre de limitation. |
| Option.BBoxWest | Coordonnée définissant la limite à l'Ouest du cadre de limitation. |
| Option.BoundingBox | Limite la recherche en fonction des coordonnées du cadre de limitation |
| Option.CoordinateSystem | Système de coordonnées à utiliser. Seul EPSG:4326 est pris en charge pour le moment. |
| Option.Database | Spécifie le nom de la base de données configurée dans Management Console. Cette information est nécessaire si plusieurs bases de données sont disponibles. |
| Option.DatabaseSearchOrder | Spécifie l'ordre dans lequel effectuer la recherche dans les bases de données si plusieurs bases de données sont disponibles. Normalement, la recherche s'effectue dans les bases de données dans leur ordre de chargement. Par exemple, l'ordre 2, 1, 3, 4 pourrait être saisi pour remplacer l'ordre par défaut. |
| Option.DefaultCountryCode | Pays par défaut si Data.Country n'est pas indiqué (code pays ISO de 3 caractères). |
| Option.DistanceFromOrigin | Étendue de la zone de recherche comme distance maximale à partir de l'origine X/Y. |
| Option.FuzzyMatch | Hard_Match, Soft_Match ou None pour spécifier le type de correspondance approximative. La valeur par défaut est None. |
| Option.GeoCompleteDictionaryPreference | Spécifie la préférence de dictionnaire concernant le dictionnaire d'adresses ou un dictionnaire utilisateur (si vous disposez d'un dictionnaire utilisateur personnalisé pour le pays). Les valeurs sont AD_ONLY (dictionnaire d'adresses uniquement), UD_ONLY (dictionnaire utilisateur uniquement), PREFER_AD (dictionnaire d'adresses en priorité), PREFER_UD, (dictionnaire utilisateur en priorité) ou BOTH_AD_UD (les deux dictionnaires sans préférence). La valeur par défaut est BOTH_AD_UD. |
| Option.GeoCompleteLevel | Niveau de recherche GeoComplete. Il peut s'agir de GeoCompleteAddress, GeoCompletePOI, GeoCompleteCategory, GeoCompleteALL ou FindNearestPOI. La valeur par défaut est GeoCompleteALL. À moins d'avoir une licence et installé les données de POI, GeoCompletePOI, GeoCompleteCategory et FindNearestPOI ne renvoient aucun candidat et seuls les candidats de rue sont renvoyés pour GeoCompleteAll. |
| Option.Locale | Les paramètres régionaux sont activés uniquement pour FindNearest POI. L'anglais est toujours disponible, et il s'agit de la langue par défaut. Vous pouvez également sélectionner Natif si les catégories et les sous-catégories de POI ont été localisées. Natif fait référence à la langue locale pour ce pays. Remarque : Cette option est disponible uniquement si vous avez une licence et installé les données de POI.
|
| Option.MatchOnAddressNumber | Indique si une correspondance de numéro d'adresse est requise. Par défaut, une correspondance de numéro d'adresse n'est pas obligatoire. |
| Option.MaxCandidates | Nombre maximal de candidats à renvoyer (1 - 100). Vous pouvez également indiquer -1 pour renvoyer le nombre maximal autorisé de candidats (100). |
| Option.NoRestriction | Ne permet aucune restriction de distance dans les recherches GeoComplete. |
| Option.Path | Chemin d'accès à l'option. |
| Option.SearchDistance | Spécifie la distance (le rayon) dans laquelle rechercher des candidats à partir de l'origine donnée. Les unités de distance sont définies par la méthode SearchRadiusUnits. Cette distance est également utilisée en tant que restriction de distance de recherche. |
| Option.SearchRadiusUnit | Unités utilisées pour Option.SearchDistance. Il peut s'agir des valeurs suivantes : KILOMETERS (KILOMÈTRES), MILES, METERS (MÈTRES) ou FEET (PIEDS). La valeur par défaut est KILOMETERS, à moins que vous ayez modifié cette préférence dans Management Console. |