Default Return Fields
The following table lists the fields that are returned by default. Unless otherwise noted, all countries have these fields returned. If a field has country-specific return values, refer to the link provided in the note.
Output Field Name | Description |
---|---|
MainAddressLine | Candidate address line. |
AreaName1 | State, province or region. |
AreaName2 | County or district. |
AreaName3 | City, town or suburb. |
AreaName4 | Locality |
PostCode1 | Main postal code. |
Country | Country |
AddressNumber | House or building number. |
StreetName | Street name. |
X | Longitude of the candidate |
Y | Latitude of the candidate. |
CoordinateSystemName | Coordinate system name for the candidate. |
FormattedStreetAddress |
The formatted main address line. |
FormattedLocationAddress | The formatted last address line. |
FeatureID | ID for the feature. |
PlaceName | Firm, company, organization, business or building name. |
AddressNumber | House or building number. |
Street | Street name. |
PrecisionCode | A code describing the precision of the geocode.
The possible match categories are as follows:
The matches in the 'S' category indicate that the record was matched to a single address candidate.
HPNTSCSZA . If a
match result was not made for the specified component, a dash (-) will appear in
place of a letter.
Note: For more detailed information including country-specific meanings and
values, see Global Result Codes.
|
PrecisionLevel | A code describing the precision of the geocode. One of
the following:
Note: This field is not returned for USA. For geocode precision information for USA,
see Location Codes.
|
Identifier | For street- or point-level candidates, this is usually the segment ID. |
SourceDictionary | Identifies the dictionary that is the source for the candidate information and data. The source dictionary is a 0-based integer value that indicates which configured dictionary the candidate came from. If you only have a single dictionary this will always be "0". |
Point | The candidate's geocode, specified as X (longitude) and Y (latitude) coordinates. |
Status | Reports the success or failure of the match attempt:
|
Status.Code | If the address could not be processed, this field will indicate
the reason.
|
Status.Description | If the address could not be processed, this field will provide a
description of the failure.
|