Custom Preferences: Interactive Geocode Service (Geocoding API) - 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
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

Custom preferences supported by the Interactive Geocode Service are for use against any country dataset. Other custom fields that apply to certain countries are located in Custom Preferences and Fields.

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

"preferences" : {
                "customPreferences" : {
                "<YOUR_CUSTOM_PREFERENCE>" : "true"
                }
Parameter Type Description

POST: SEARCH_TYPE

String Custom preference to control search type of interactive requests.

default: ADDRESS_COMPLETION

possible values:
ADDRESS_COMPLETION,
POINT_OF_INTEREST_COMPLETION,  POINT_OF_INTEREST_NAME_COMPLETION,                       POINT_OF_INTEREST_CATEGORY_COMPLETION,
STATE_PROVINCE_COMPLETION,
WORLD_PLACES
ALL

POST:

COMPRESSED_AREA_RESULT

Boolean Limits the search to given administrative area. Default: false

POST:

KEY_CUSTOM_DICTIONARY_USAGE

String possible values:

PREFER_CUSTOM_DICTIONARIES, PREFER_STANDARD_DICTIONARIES,
USE_CUSTOM_DICTIONARIES_ONLY, USE_STANDARD_DICTIONARIES_ONLY