Output Fields

Output fields for the Interactive Geocode Service.


Parameter	Type	Description
formattedAddress	String	Includes all relevant pieces of address such as unit, street address, admin and postal.
identifier	String	A unique ID for the candidate. This is available at the levels for candidate, ranges and units.
Other output fields	varies	Same as those for Geocoding service. See Geocode Output Fields
totalPossibleCandidates	Integer	Indicates the total number of possible candidates.
formattedStreetAddress	String	The formatted main address line.
formattedLocationAddress	String	The formatted last address line.
identifier	String	A unique ID for the candidate. This is available at the levels for candidate, ranges and units.
totalMatches	Integer	Indicates the total number of matches.
matching object of type FieldsMatching, consisting of an array with one or more match candidates. Contains the following elements:
matchOnAddressNumber	Boolean	Indicates if the input address number matched the candidate's address number. true The input address number matched the candidate's address number. False The input address number did not match the candidate's address number.
geometry object. Returned geocode consisting of the following elements:
coordinates	Double	The candidate's geocode, specified as x (longitude) and y (latitiude) coordinates separated by a comma.
properties	String	The coordinate reference system (CRS) used for the candidate's geocode, in epsg:nnnn format. Default is epsg:4326.
address object. Returned candidate address which may contain some of the following elements:
mainAddressLine	String	Candidate address line.
addressLastLine	String	Candidate last address line.
placeName	String	Firm, company, organization, business or building name.
areaName1	String	State, province or region.
areaName2	String	County or district.
areaName3	String	City, town or suburb.
areaName4	String	Locality
postCode1	String	Main postal code.
postCode2	String	Secondary postal code, where one exists.
country	String	Name of country in Alpha-2 or Alpha-3 format, or a common name of the country, such as United States of America.
addressNumber	String	House or building number.
streetName	String	Street name.
unitType	String	The type of unit, such as Apt., Ste. or Bldg.
unitValue	String	The unit number, such as "3B".
ranges: CandidateRange object. Contains information about a candidate's ranges, consisting of the following elements:
placeName	String	If applicable, indicates the name of the candidate's place or building.
lowHouse	String	Indicates the low house number in the candidate's street range.
highHouse	String	Indicates the high house number in the candidate's street range.
side	String	Provides information on the side of street that the candidate's range is located. LEFT The range is on the left side of the street. RIGHT The range is on the right side of the street. BOTH The range is on both the left and right side of the street. UNKNOWN No information is available on the side of the street this range is located.
customValues	Map	A map of local values associated with the candidate's range.
units: CandidateRangeUnit object. Contains information about a candidate range's units, consisting of the following elements:
placeName	String	If applicable, indicates the name of the candidate's place or building.
unitType	String	Indicates the unit type (APT, STE, etc.).
highUnitValue	String	Indicates the high unit number for this range unit.
lowUnitValue	String	Indicates the low unit number for this range unit.
customValues	Map	A map of local values associated with the unit.