The candidate addresses are returned one per row. If no rows are returned, then there are no matching candidates. Each row contains one or more of the elements shown in the below table, and the fields are not returned when they are empty.
|
ResponseElement |
Description |
|---|---|
|
AddressLine1 |
The first line of the address. |
|
ApartmentLabel |
Label of the apartment, such as Apt, Flat. |
|
City |
The city name. |
|
FirmName |
The firm or company name. This field is only available for selected countries. |
|
FormattedAddress |
The formatted address in a single line that shouldbe displayed to you as you type. |
|
InstanceKey |
Typically, it returns the InstanceKey passed asinput. When the InstanceKey gets too old, a new one will bereturned, and that should be passed to subsequent calls toGlobalTypeAhead. |
|
PostalCode |
The ZIP Code™ or postal code. |
|
StateProvince |
The state or province, abbreviated when postalstandard requires. |
|
Status |
When it contains F, the call has failed forthe specified reason. If missing, then no error occurred. |
|
Status.Code |
No known error codes are expected. |
|
Status.Description |
No known error descriptions are expected. |
|
Locality |
The locality. |
|
ProcessedBy |
Indicates which address coder processed the address. |
|
PostalCode.AddOn |
The 4-digit add-on part of the ZIP Code™. For example, in the ZIPCode™ 60655-1844, 1844 is the 4-digit add-on. |
|
HouseNumber |
House number, for example: 123 E Main St Apt 3. |
|
RangeCount |
The number of ranges for the candidate. |
|
Ranges |
Additional information for each range identified for the candidate.
|