Input Address Fields - 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-11-14
Published on
2024-11-14T12:57:29.533342

Input addresses include the address fields for input. The below table lists Input Address fields:

Table 1.
Parameter Type Description
addressLines String Requested address, based on the country's addressing standard.

Single-line request:

10 downing street london SW1A 2AA

Multi-line request:

10 DOWNING STREET, LONDON, SW1A 2AA

addressNumber String House or building number.

10 or 630

admin1 String The largest geographic area, typically a state or province.

New York or Maharashtra.

admin2 String The secondary geographic area, typically a county or district.

Douglas County or West Mumbai.

city String Specifies a city or town name.

New York City

country String Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).

USA

postalCode String Main postal code.

80125

postalCodeExt String Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012
placeName String If applicable, indicates the name of the candidate's place or building.

PRIME MINISTER& FIRST LORD OF THE TREASURY

addressId String Address Id for the request.

1

The following fields are no longer used and will be deprecated in the upcoming releases.
Table 2. Fields no longer used
Parameter Type Description
street String Street name only (no directional or street suffix).
suburb String Mixed-use or residential area within commuting distance of a city or urban area.
floor String Each level within a building.
neighborhood String A city subdivision or locality.

Highlands Ranch

room String A single room within a building.
borough String Unit of local government or other administrative subdivision.

Vazira or Manhattan

building String A roofed and walled structure built for permanent use.
unit String The unit number, such as 3B.
unitType String A group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (APT, STE, FLAT, etc.).