GCM to GGM REST API Mappings

Table 1. REST API field mappings from GCM to GGM
GCM GGM Description
Data.AddressLine1 address.mainAddressLine Single Line input
Data.Category address.customFields:CATEGORY Point of interest category
Data.City address.areaName3 City to search. Combine with AddressLine1 to return candidates in your targeted area.
Data.Country address.country Specifies the country to search (3-character country ISO code).
Data.OriginLatitude address.preferences.originXY Y Coordinate of origin.
Data.OriginLongitude address.preferences.originXY X Coordinate of origin.
Data.PostalCode address.postCode1 Postcode
Data.StateProvince address.areaName1 State or province
Option.BBoxEast preferences.restrictedSearch.northEastXY The coordinate defining the eastern boundary of the bounding box.
Option.BBoxNorth preferences.restrictedSearch.northEastXY The coordinate defining the northern boundary of the bounding box.
Option.BBoxSouth preferences.restrictedSearch.southWestXY The coordinate defining the southern boundary of the bounding box.
Option.BBoxWest preferences.restrictedSearch.southWestXY The coordinate defining the western boundary of the bounding box.
Option.BoundingBox Not supported Limits the search to the coordinates of the bounding box
Option.CoordinateSystem preferences.clientCoordSysName Coordinate system to use. Currently only EPSG:4326 is supported.
Option.DatabaseSearchOrder Not supported 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 Not supported Default country if Data.Country is not specified (3-character country ISO code).
Option.DistanceFromOrigin Not supported The extent of the search area as the maximum distance from the X/Y origin.
Option.FuzzyMatch preferences.matchMode Hard_Match, Soft_Match, or None to specify the type of fuzzy match. The default is None.
Option.GeoCompleteDictionaryPreference preferences.customPreferences:KEY_CUSTOM_DICTIONARY_USAGE 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 preferences.customPreferences:SEARCH_TYPE 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 preferences.clientLocale 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 preferences.mustMatchFields.matchOnAddressNumber Specifies whether an address number match is required. By default, an address number match is not required.
Option.MaxCandidates preferences.maxReturnedCandidates Maximum number of candidates to return (1 - 100). Or specify -1 to return the maximum allowable number of candidates (100).
Option.NoRestriction Not supported Allows no distance restrictions with GeoComplete searches.
Option.Path Not supported Option path.
Option.SearchDistance preferences.distance 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 preferences.distanceUnits 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.