Request Fields - 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

The input address may contain some or all of the following address elements.

Note: Some parameters are identified with POST and GET. Those with both indicate a difference in the parameter name. The parameters with no POST and GET are used for either request type using the same parameter name. Other parameters are either POST or GET as marked.
Parameter Type Description


                  POST: mainAddressLine


                  GET: mainAddress

String Input address field.
addressNumber String House or building number.
streetName String Street name.
unitType String Specifies the type of unit, such as Apt., Ste. and Bldg.
unitValue String Specifies the unit value/number, such as "3B".
areaName1 String Specifies the largest geographic area, typically a state or province. Optional.
areaName2 String Specifies the secondary geographic area, typically a county or district. Optional.
areaName3 String Specifies a city or town name. Optional.
areaName4 String Specifies a city subdivision or locality. Optional.


                  POST: postCode1


                  GET: postalCode

String The postal code in the appropriate format for the country. Optional.


                  POST: postCode2

String Postal code add on. For example, zip+4 in USA. Optional.
placeName String Building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional. For example:

Precisely
                          4750 Walnut St.
                          Boulder, CO 80301

country String Name of a country in ISO 3166-1 format (Alpha-2, Alpha-3, or numerical), or a common name of the country, such as United States of America.


                  POST: addressLastLine


                  GET: lastLine

String The last line of the address. Optional.
     
type String

Indicates the geocode type to be performed.

ADDRESS
Geocode to a street address. Default.
GEOGRAPHIC
Geocode to the geographic centroid of a city or state.
POSTAL
Geocode to a postal code.