Interactive Geocode Service POST Request

A POST request to the Interactive Geocode Service service enables you to enter an address and get immediate feedback as it tries to find match candidates. The returned point is a postal centroid. All the preferences in interactive geocoding can be included in a POST request.

Base URI

http://<server>:<port>/<contextpath>/rest/GeocodeService/geocode[.content type]

Where:

[.content type] indicates that the specified content type will be used by default. Optional.
json
Default content type is JSON, unless superseded by HTTP content negotiation
xml
Default content type is XML, unless superseded by HTTP content negotiation

Preferences

The format for using these preferences is preferences.CustomPreferences.[<name of preference>] or preferences.[<name of preference>].

Parameter Type Description
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, ALL
COMPRESSED_AREA_RESULT boolean default: false

COMPRESSED_AREA_RESULT
KEY_CUSTOM_DICTIONARY_USAGE string possible values: PREFER_CUSTOM_DICTIONARIES, PREFER_STANDARD_DICTIONARIES, USE_CUSTOM_DICTIONARIES_ONLY, USE_STANDARD_DICTIONARIES_ONLY
USE_STANDARD_DICTIONARIES_ONLY
matchMode string default: STANDARD,

possible values:
RELAXED

STANDARD,

CLOSE
originXY List Double 
{
"preferences" : 
  {
  "originXY" : [-73.70252500000001, 42.68323]
    },
  "address" : 
  {
  "mainAddressLine" : "350 Jordan Rd"
  }
}
restrictedSearch Bounds 
{
"preferences":
     {
     "restrictedSearch": 
	{"northEastXY": [-73.70252500000001,42.68323],
	"southWestXY": [-73.70252500000001,42.68323]
	}
		},
	"address": 
     {
     "mainAddressLine": 
	"350 Jordan Rd"
	}
}