Output

Table 1. Reverse Geocode Address Global Output Fields

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.

City

The municipality name.

Data.County

The meaning of county varies by country.

  • FRA (France)—Department

The department name.

Distance

The distance from input location in meters. If the input coordinates are an exact match for the address, the value is 0.

FirmName

Name of the company or a place name.

Geocoder.MatchCode

Indicates how closely the input coordinates match the candidate address. For more information, see Reverse Geocoding Codes (R Codes).

HouseNumber

The building number for the matched location.

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.

E
Even
O
Odd
B
Both
U
Unknown

Language

For reverse geocoded candidates, the two-character language code is returned.

LastLine

Complete last address line (city, state/province, and postal code).

LeadingDirectional

Street directional that precedes the street name. For example, the N in 138 N Main Street.

Data.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.

  • FRA (France)—Not used

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. This field is not used by most countries.

PreAddress

Miscellaneous information that appears before the street name.

PrivateMailbox

This field is not currently used.

SegmentCode

A unique ID that identifies a street segment.

SegmentParity

Indicates which side of the street has odd numbers.

L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Undetermined

Data.StateProvince

The meaning of State/Province varies by country.

  • FRA (France)—Region

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.

StreetPrefix

The type of street when the street type appears before the base street name.

StreetSuffix

The type of street when the street type appears after the base street name.

TrailingDirectional

Street directional that follows the street name.

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.