The address may be identical to the input address if the input address was accurate, or it may be a standardized version of the input address, or it may be a candidate address when multiple matches are found.
Response Element |
Description |
||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AddressLine1 |
First line of the address. |
||||||||||||||||||||||||||||||||
AddressLine2 |
Second line of the address. |
||||||||||||||||||||||||||||||||
ApartmentLabel |
The type of unit, such as apartment, suite, or lot. |
||||||||||||||||||||||||||||||||
ApartmentNumber |
Unit number. |
||||||||||||||||||||||||||||||||
ApartmentNumber.Input |
Unit number as it was input |
||||||||||||||||||||||||||||||||
City |
The municipality name. |
||||||||||||||||||||||||||||||||
Country |
The three-letter ISO 3166-1 Alpha 3 country code. For Australia, the country code is AUS. |
||||||||||||||||||||||||||||||||
County |
The meaning of county varies by country. The Local Government Authority (LGA) name.
|
||||||||||||||||||||||||||||||||
DataType |
The returned numeric value represents a data vendor.
|
||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
FirmName |
Name of the company or a place name. |
||||||||||||||||||||||||||||||||
HouseNumber |
The buildinglot number for the matched location. For Japan, this field contains the lot number. |
||||||||||||||||||||||||||||||||
HouseNumberHigh |
The highest house number of the range in which the address resides. |
||||||||||||||||||||||||||||||||
HouseNumberLow |
The lowest house number of the range in which the address resides. |
||||||||||||||||||||||||||||||||
HouseNumberParity |
Indicates if the house number range contains even or odd numbers or both.
|
||||||||||||||||||||||||||||||||
IsCloseMatch |
Indicates whether candidate is a close match. | ||||||||||||||||||||||||||||||||
LastLine |
Complete last address line (city, state/province, and postal code). |
||||||||||||||||||||||||||||||||
Latitude |
Latitude of the candidate. |
||||||||||||||||||||||||||||||||
LeadingDirectional |
Street directional that precedes the street name. For example, the N in 138 N Main Street. |
||||||||||||||||||||||||||||||||
Locality |
The meaning of locality varies by country. Generally a locality is a village in rural areas or it may be a suburb in urban areas. When used, a locality typically appears on the last line of the address with the postcode.
|
||||||||||||||||||||||||||||||||
Longitude |
Longitude of the candidate. |
||||||||||||||||||||||||||||||||
NumberOfCandidateRanges |
Indicates the number of ranges of which the candidate is a member. A candidate may be a part of multiple ranges if the candidate is a street instead of a building. To specify the number of ranges to return for each candidate, use the MaxRanges option. |
||||||||||||||||||||||||||||||||
NumberOfRangeUnits |
Indicates the number of units included in the range. A unit is an address within a building, such as an apartment or office suite. |
||||||||||||||||||||||||||||||||
PostalCode |
The postal code for the address. The format of the postcode varies by country. Postcode data is not available for every country. |
||||||||||||||||||||||||||||||||
PostalCode.Addon |
The second part of a postcode. For Canadian addresses this will be the LDU. This field is not used by most countries. |
||||||||||||||||||||||||||||||||
PostalCode.Base |
The first part of a postcode. For Canadian addresses this will be the FSA. This field is not used by most countries. |
||||||||||||||||||||||||||||||||
PreAddress |
Miscellaneous information that appears before the street name. |
||||||||||||||||||||||||||||||||
PrivateMailbox |
This field is not currently used. |
||||||||||||||||||||||||||||||||
SegmentParity |
Indicates which side of the street has odd numbers.
|
||||||||||||||||||||||||||||||||
StateProvince | The meaning of State/Province varies by country.
|
||||||||||||||||||||||||||||||||
StreetDataType |
The default search order rank of the database used to geocode the address. A value of "1" indicates that the database is first in the default search order, "2" indicates that the database is second in the default search order, and so on. The default database search order is specified in the Management Console. |
||||||||||||||||||||||||||||||||
StreetName |
For most countries, this contains the street name. In Japan, this contains the block. Japanese addresses typically do not have street names. |
||||||||||||||||||||||||||||||||
StreetPrefix |
The type of street when the street type appears before the base street name. |
||||||||||||||||||||||||||||||||
TrailingDirectional |
Street directional that follows the street name. For example, the N in 456 3rd St. N. |
||||||||||||||||||||||||||||||||
UnitNumberHigh |
The highest unit number of the range in which the unit resides. |
||||||||||||||||||||||||||||||||
UnitNumberLow |
The lowest unit number of the range in which the unit resides. |