Características de la API de REST
El módulo incluye métodos de la API de REST para controlar y personalizar los valores y opciones predeterminados.
| Método REST | Descripción |
|---|---|
| Data.AddressLine1 | Entrada en una sola línea |
| Data.Category | Categoría de punto de interés |
| Data.City | Ciudad para buscar. Combine con AddressLine1 para devolver candidatos en su área objetivo. |
| Data.Country | Especifica el país para buscar (código de país ISO de 3 caracteres). |
| Data.OriginLatitude | Coordenada Y del origen. |
| Data.OriginLongitude | Coordenada X del origen. |
| Data.PostalCode | Postcode |
| Data.StateProvince | Estado o provincia |
| Option.BBoxEast | La coordenada que define el límite del este del cuadro delimitador. |
| Option.BBoxNorth | La coordenada que define el límite del norte del cuadro delimitador. |
| Option.BBoxSouth | La coordenada que define el límite del sur del cuadro delimitador. |
| Option.BBoxWest | La coordenada que define el límite del oeste del cuadro delimitador. |
| Option.BoundingBox | Limita la búsqueda a las coordenadas del cuadro delimitador |
| Option.CoordinateSystem | El sistema de coordenadas que se va a usar. Actualmente solo se admite EPSG:4326. |
| Option.Database | Especifica el nombre de la base de datos configurada en Management Console. Este es necesario si más de una base de datos está disponible. |
| Option.DatabaseSearchOrder | Especifica el orden en el cual se deben buscar las bases de datos, si más de una está disponible. Normalmente, las bases de datos se buscan en el orden cargado. Por ejemplo, el orden podría ingresarse como 2, 1, 3, 4 para anular el orden predeterminado. |
| Option.DefaultCountryCode | País predeterminado si Data.Country no está especificado (código de país ISO de 3 caracteres). |
| Option.DistanceFromOrigin | El alcance del área de búsqueda como la distancia máxima desde el origen X/Y. |
| Option.FuzzyMatch | Hard_Match, Soft_Match o Ninguno para especificar el tipo de coincidencia parcial. El valor predeterminado es Ninguno. |
| Option.GeoCompleteDictionaryPreference | Especifica la preferencia de diccionario por diccionario de direcciones o diccionario de usuario (si tiene un diccionario de usuario personalizado para el país). Los valores son AD_ONLY (solo diccionario de direcciones), UD_ONLY (solo diccionario de usuario), PREFER_AD, (diccionario de direcciones preferido), PREFER_UD, (diccionario de usuario preferido) o BOTH_AD_UD (usar ambos sin preferencia). El valor predeterminado es BOTH_AD_UD. |
| Option.GeoCompleteLevel | El nivel de búsqueda de GeoComplete. Este puede ser GeoCompleteAddress, GeoCompletePOI, GeoCompleteCategory, GeoCompleteALL o FindNearestPOI. El valor predeterminado es GeoCompleteALL. A menos que tenga datos de POI instalados y con licencia, GeoCompletePOI, GeoCompleteCategory y FindNearestPOI no devolverán candidatos. Para GeoCompleteAll solo se devolverán candidatos de calle. |
| Option.Locale | La configuración local solo se habilita para FindNearest POI. Inglés siempre está disponible y esa es la configuración local predeterminada. También puede seleccionar Nativo si se han localizado las categorías y subcategorías POI. Nativo hace referencia al idioma local de ese país. Nota: Esta opción solo está disponible si tiene datos de POI instalados y con licencia.
|
| Option.MatchOnAddressNumber | Especifica si se requiere un cruce de número de dirección. De manera predeterminada, no se requiere un cruce de número de dirección. |
| Option.MaxCandidates | Cantidad máxima de candidatos que se va a devolver (1 a 100). O especifique -1 para devolver la cantidad máxima permitida de candidatos (100). |
| Option.NoRestriction | Permite que no haya restricciones de distancia con búsquedas de GeoComplete. |
| Option.Path | Ruta de acceso de la opción. |
| Option.SearchDistance | Especifica la distancia (radio) para buscar los candidatos desde el origen dado. Las unidades de distancia se definen mediante el método SearchRadiusUnits. Esta distancia también se usa como una restricción de distancia de búsqueda. |
| Option.SearchRadiusUnit | Las unidades utilizadas para Option.SearchDistance. Los valores pueden ser (KILÓMETROS, MILLAS, METROS o PIES). El valor predeterminado es KILÓMETROS, salvo que cambie dicha preferencia en Management Console. |