REST API Features
Important: The GeoComplete Module and its REST and
SOAP APIs have been deprecated. If you are creating applications that use the type-ahead
feature of GeoComplete, we recommend that you use the Interactive service in the Global
Geocoding Module and the REST API in Spectrum™ Technology Platform version 12.0 SP2.
Interactive is a type ahead feature using a new data type called Interactive.
The module includes REST API methods
to control and customize defaults and options.| REST Method | Description |
|---|---|
| Data.AddressLine1 | Single line input |
| Data.Category | Point of interest category |
| Data.City | City to search. Combine with AddressLine1 to return candidates in your targeted area. |
| Data.Country | Specifies the country to search (3-character country ISO code). |
| Data.OriginLatitude | Y Coordinate of origin. |
| Data.OriginLongitude | X Coordinate of origin. |
| Data.PostalCode | Postcode |
| Data.StateProvince | State or province |
| Option.BBoxEast | The coordinate defining the eastern boundary of the bounding box. |
| Option.BBoxNorth | The coordinate defining the northern boundary of the bounding box. |
| Option.BBoxSouth | The coordinate defining the southern boundary of the bounding box. |
| Option.BBoxWest | The coordinate defining the western boundary of the bounding box. |
| Option.BoundingBox | Limits the search to the coordinates of the bounding box |
| Option.CoordinateSystem | Coordinate system to use. Currently only EPSG:4326 is supported. |
| Option.Database | Specifies the name of the database configured in Management Console. This is required if more than one database is available. |
| Option.DatabaseSearchOrder | Specifies the order in which to search the databases if more than one database is available. Normally, the databases are searched in the loaded order. For example, the order could be entered as 2, 1, 3, 4 to override the default order. |
| Option.DefaultCountryCode | Default country if Data.Country is not specified (3-character country ISO code). |
| Option.DistanceFromOrigin | The extent of the search area as the maximum distance from the X/Y origin. |
| Option.FuzzyMatch | Hard_Match, Soft_Match, or None to specify the type of fuzzy match. The default is None. |
| Option.GeoCompleteDictionaryPreference | Specifies the dictionary preference for address dictionary or user dictionary (if you have a custom user dictionary for the country). Values are AD_ONLY (address dictionary only), UD_ONLY (user dictionary only), PREFER_AD, (prefer address dictionary), PREFER_UD, (prefer user dictionary), or BOTH_AD_UD (use both with no preference). The default is BOTH_AD_UD. |
| Option.GeoCompleteLevel | The GeoComplete search level. This can be GeoCompleteAddress, GeoCompletePOI, GeoCompleteCategory, GeoCompleteALL, or FindNearestPOI. The default is GeoCompleteALL. Unless you have licensed and installed POI data, GeoCompletePOI, GeoCompleteCategory, and FindNearestPOI will not return any candidates and only street candidates will be returned for GeoCompleteAll. |
| Option.Locale | Locale is enabled only for FindNearest POI. English is always
available and that is the default locale. You can also select Native if
the POI categories and subcategories have been localized. Native refers
to the local language for that country. Note: This option is available
only if you have licensed and installed POI data.
|
| Option.MatchOnAddressNumber | Specifies whether an address number match is required. By default, an address number match is not required. |
| Option.MaxCandidates | Maximum number of candidates to return (1 - 100). Or specify -1 to return the maximum allowable number of candidates (100). |
| Option.NoRestriction | Allows no distance restrictions with GeoComplete searches. |
| Option.Path | Option path. |
| Option.SearchDistance | Specifies the distance (radius) to search for candidates from the given origin. Distance units are defined by the SearchRadiusUnits method. This distance is also used as a search distance restriction. |
| Option.SearchRadiusUnit | Units used for Option.SearchDistance. Values can be (KILOMETERS, MILES, METERS, or FEET). The default is KILOMETERS, unless you changed that preference in Management Console. |