SpatialStream® Web Services - GetGeocode Reference

GetGeocode Reference

GetGeocode takes in an address and potentially a list of fields and will return a list of records corresponding to that address. Many of the address fields can be omitted, changing the location searched. Supports Resource Chaining.

Input

Parameter name	Type	Description
fields	Comma separated alpha-numeric string	Comma separated list of columns to return. Supports chained fields.
showSchema	Boolean	Set to true to see all the field definitions in the response layers. Default: true
output	String	The output type for the page. Possible types include 'XML', 'JSON', 'JSONXML', 'HTML', 'CSV', 'excel.sheet', and 'CUSTOM'.
obsId	String	(Required for JSON/JSONXML output) The object listening for the JSON callback.
obsSuccessMethod	String	(Required for JSON/JSONXML output) The JSON success callback function.
obsErrorMethod	String	(Required for JSON/JSONXML output) The JSON error callback function.
transformer	String	(Required for CUSTOM output) The XSLT to use to transform the XML output.
address	String	(Required) Unparsed Street Address. {eg: 122 Main St}
city	String	City name.
state	Alphabetic string	The State name. It can be an abbreviation or fully qualified name.
zip	String	The five-digit zip code. Optionally followed by a dash then four digits.
country	Alphabetic string	An ISO 3166-1 Country Code to decode different Country Location IDs. Default: US.
returnGeoType	Alpha-numeric string	The returning geometry type. There are 3 return types. 1 = geometry ( the whole geometry is returned) 2 = none ( no geometry is returned) 3 = centroid ( only centroid)
minScore	Positive integer	The minimum score to required to match results. Values from 0 - 100. The default is 50.
dataSource	Comma separated alpha-numeric string	(Required) Comma delimited list of datasource alias names. These are configurable per account and can include custom address sources. For a typical account this will contain standard layers "Parcels,Street_Centerline". The order in the string controls which source is higher priority, sources later in the string will only be used if a good match is not found in an earlier resource. So "Parcels,Street_Centerline" will use the parcel match ahead of a Street_Centerline match. If a custom layer is uploaded and published as an address source it would typically be added to the front of the string, eg. "Custom,Parcels,Street_Centerline". The Custom dataSource can be compiled from an editable layer allowing for end user update to provide improved location. Note: the dataSources for geocoding are not the same as the layer resources used in other functions, the data needs to be compiled into a format specifically for high speed geocoding.

Output

See Resource Chaining.

The Response attributes are:

Parameter	Value	Description
DataSource	String	The originating source of the data.
ID	String	The record unique key identifier. For PARCELS DataSource this ID will be FIPS_APN.
Address	String	The first line street address.
City	String	The city name
State	String	The state name.
Zipcode	String	The 5 digit zip code.
GEOMETRY	String	WKT representation of a centroid of a geometry.
Score	Int	A number for 0 - 100 indicating the accuracy of the result. 100 is most accurate and 0 is least accurate.
MatchCodes	String	For future use.