Default Return Fields

The following table lists the fields that are returned by default.

Output Field Name Description
Formatted Street Address

The formatted main address line.
Formatted Location Address The formatted last address line.
Precision Code A code describing the precision of the geocode.

The format of the geocode result string is match_category[additional_match_information].

The possible match categories are as follows:

Z1
Postal match with post code 1 centroid.
Z2
Postal match with partial post code 2 centroid.
Z3
Postal match with post code 2 centroid.
G1
Geographic match with area name 1 centroid.
G2
Geographic match with area name 2 centroid.
G3
Geographic match with area name 3 centroid.
G4
Geographic match with area name 4 centroid.

The matches in the 'S' category indicate that the record was matched to a single address candidate.

SX
Point located at a street intersection.
SC
Match point located at the house-level that has been projected from the nearest segment.
S0
No coordinates are available, but parts of the address may have matched the source data.
S4
The geocode is located at a street centroid.
S5
The geocode is located at a street address.
S7
The geocode is located at a street address that has been interpolated between point house locations.
S8
Match point located at the house location.
Additional match information is of the format HPNTSCSZA. If a match result was not made for the specified component, a dash (-) will appear in place of a letter.
H
House number.
P
Street prefix direction.
N
Street name.
T
Street type.
S
Street suffix direction.
C
Town name.
Z
Post code.
A
Geocode dataset.
U
Custom User Dictionary.
For more information, see Global Result Codes.
Precision Level A code describing the precision of the geocode. One of the following:
0
No coordinate information is available for this candidate address.
1
Interpolated street address.
2
Street segment midpoint.
3
Postal code 1 centroid.
4
Partial postal code 2 centroid.
5
Postal code 2 centroid.
6
Intersection.
7
Point of interest. (If database contains POI data.)
8
State/province centroid.
9
County centroid.
10
City centroid.
11
Locality centroid.
12-15
Reserved for unspecified custom items.
16
The result is an address point.
17
The result was generated by using address point data to modify the candidate's segment data.
18
The result is an address point that was projected using the centerline offset feature. You must have both a point and a street range database to use the centerline offset feature.
19
Inside a buildling structure.
Source Dictionary 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.
Search Distance The distance of the radius that was set for searching for a match to the input coordinates.
Search Distance Units The unit of measurement that was set for the search distance.
Status Reports the success or failure of the match attempt:
nullSuccess
FFailure
Status.Code If the address could not be processed, this field will indicate the reason.
  • Internal System Error
  • No Geocode Found
  • Insufficient Input Data
Status.Description If the address could not be processed, this field will provide a description of the failure.
Problem + explanationReturned when Status.Code = Internal System Error
Geocoding FailedReturned when Status.code = No Geocode Found
No location returnedReturned when Status.code = No Geocode Found