Custom Preferences Geocode Service - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide
Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
Last updated
2024-09-12
Published on
2024-09-12T14:50:21.470801

Custom preferences supported by the Geocode Service are for use against any country dataset.

To create a custom preference for a POST request, follow this code snippet. 

"preferences" : {
     "customPreferences" : {
         "<YOUR_CUSTOM_PREFERENCE>" : "true"
     }
}

For example:

"preferences": {
     "customPreferences": {
         "FIND_DPV": "true",
         "FIND_SUITELINK": "true"
     }
}
Parameter Type Description

FALLBACK_TO_WORLD

 String When World Places is installed, the geocoder specifies whether to use World Places to determine a geocode when any of the following conditions exist:
  • A country geocoder is not installed
  • A country geocoder is installed without a geocoding dataset
  • A street match with the country geocoder cannot be made
World Places may return either a postal or geographic geocode depending on the level of support in the dataset. Optional.
true
Use World Places Geocoder for matching when a country geocoder is not installed, a country geocoder is installed without a geocoding dataset, or a street match with the country geocoder cannot be made. Default.
false
Do not use World Places Geocoder.

The customPreferences object is specified in the preferences object. See example at the top of this table.

GEOCODE_TYPE String Set the type of geocode. Values are:
  • GEOGRAPHIC/POSTAL
  • ADDRESS (default)
MATCH_ON_ADDRESS_NUMBER Boolean When set to true, a match must be made to the input address number. When set to false, a match need not be made to the input address number. By default this preference is set to false.
MATCH_ON_POSTAL_CODE Boolean When set to true, a match be made to the input PostalCode1 field. When set to false, a match need not be made to the input PostalCode2 field. By default this preference is set to false.
MATCH_ON_POSTAL_CODE_EXT Boolean When set to true, a match be made to the input PostalCode2 field. When set to false, a match need not be made to the input PostalCode2 field. By default this preference is set to false.
MATCH_ON_ADMIN1 Boolean When set to true, a match be made to the input AreaName1 field. When set to false, a match need not be made to the input AreaName1 field. By default this preference is set to false.
MATCH_ON_ADMIN2 Boolean When set to true, a match be made to the input AreaName2 field. When set to false, a match need not be made to the input AreaName2 field. By default this preference is set to false.
MATCH_ON_CITY Boolean When set to true, a match be made to the input AreaName3 field. When set to false, a match need not be made to the input AreaName3 field. By default this preference is set to false.
MATCH_ON_NEIGHBORHOOD Boolean When set to true, a match be made to the input AreaName4 field. When set to false, a match need not be made to the input AreaName4 field. By default this preference is set to false.
MATCH_ON_PLACE_NAME Boolean When set to true, a match be made to the input PlaceName field. When set to false, a match need not be made to the input PlaceName field. By default this preference is set to false.
MATCH_ON_STREET_NAME Boolean When set to true, a match be made to the input StreetName field. When set to false, a match need not be made to the input StreetName field. By default this preference is set to false.
RETURN_FORMATTED_ADDRESS Boolean
When set to true, the Address Lines in the output will be returned in the country-specific postal format for Geocode or Verify candidates. By default, this preference is set to false.
Note: Setting this preference to true has an impact on overall performance.

RETURN_PARSED_INPUT

 Boolean The Parsed Input address displays the formatted input street address and each input address element in a separate field. This feature can help you understand how the input address was parsed by the geocoder and identify specific input elements that could not be geocoded. For example, a returned PARSED_INPUT_ADDRESS_NUMBER could contain an invalid house number in your input address. Optional.
true
Return parsed input address element in GeocodeServiceResponse object.
false
Do not return parsed input address element in GeocodeServiceResponse object. Default.

The customPreferences object is specified in the preferences object. See example at the top of this table.

SEARCH_WORLD_PLACES String This option specifies to only use the World Geocoder for geocoding. Regardless of any other configured data, if you have the World Geocoder configured and set either the FallbacktoGeographic or FallbacktoPostal to true, you can use the custom preference "SEARCH_WORLD_PLACES" to geocode against just the World data. Optional.
true
Use only the World Geocoder for geocoding. This option ignores all other configured data. Default.
false
Do not use only the World Geocoder for geocoding. Use other configured data.

The customPreferences object is specified in the preferences object. See example at the top of this table.

USE_ADDRESS_POINT_INTERPOLATION

 Boolean

Address point interpolation is a patented process that results in a more accurate interpolated point. It improves upon regular street segment interpolation by using point data in the interpolation process, as opposed to using street segments alone.

KEY_CUSTOM_DICTIONARY_USAGE

 String Possible values: PREFER_CUSTOM_DICTIONARIES, PREFER_STANDARD_DICTIONARIES, USE_CUSTOM_DICTIONARIES_ONLY, USE_STANDARD_DICTIONARIES_ONLY

PREFER_POBOX_OVER_STREET

 Boolean

For countries that support PO Box addresses, this preference allows you to prefer the PO Box match over the Street match.

GEOHASH_LEVEL String Sets the precision of the geohash. By default, this is set to the highest level of precision, "12" characters. Enter a value "1" through "12".
RETURN_GEOHASH Boolean When set to true, returns the GEOHASHoutput field (LAT and LON custom fields as a 32-bit encoded string representing an area in . Default = false.
REMOVE_ACCENT_MARKS Boolean When set to true accent marks are excluded from the output. Accent marks are symbols written above or below a letter to indicate a difference in pronunciation. By default they are displayed in the output.
RETURN_ALT_LANG_FIELDS Boolean When set to true, the input address is converted to the alternate language supported by the geocoder. By default, this preference is set to false.
FALLBACK_TO_STREET_CENTROID Boolean When set to true, it returns the street centroid level match (S4) for input with no matching house number. By default, this preference is set to false
RETURN_INPUT_HOUSE_ON_S4_MATCH Boolean When set to false, and there is no match on the input house number, the candidate returned will not contain a house number along with it. By default, this preference is true.
RESOLVE_ADMIN_FIELDS Boolean When set to true, the additional fields such as isoAlpha2Code, isoAlpha3Code, isoNumericCode, and the admin1 (longName, shortName) in the output will be populated. By default, the preference is set to false.
INPUT_REMOVE_ACCENT_MARKS Boolean Flag to replace the accented characters like í, ñ etc. with respective latin i or n from the input.
SEARCH_UNIT_INFORMATION Boolean Enables search on the unit information if supported for a country. By default this feature is disable.
Note: With the enablement of this preference, there might be cases where the customer may observe some performance implications as it leads to the wider searches and more processing.
MAX_CANDIDATE String Determines the number of candidates being returned. A higher number for max candidates would widen the searches and may have perofrmance implications. Also, this is used to restrict the searches as soon as the relevant number of canidates is achevied.
MAX_RESULTS Integer The maximum number of candidates to return.