The SearchResponse structure is the top level element returned by geocode, reverse geocode and landmark geocode requests. It contains Meta Information and one or more View elements. Each view consists of a list of Results wrapping the actual Location object found for the request together with information about the Match Quality of the result.

The Location is the central entity of a search result. It provides information about the geographical position as well as the Address of the location. Address Details, Address Names, and Street Details expose detailed information on the address elements. The identifiers stored in the Map Reference enable cross referencing into other services or data applications based on HERE Map Content. The most common map attributes for a navigable link are integrated directly in the Geocoder response and are exposed in the Link Info element whereas the Admin Info element exposes country or state meta information for the administrative area of a location like the Timezone. A Location can be related to other Locations. This relationship is modeled by the Related Location element.

Figure 2. Overview Location Type

Response (SearchResponseType)

Table 1. Response elements
Type Description
MetaInfo Meta Information about the Request
View Search Results are grouped in Views.

MetaInfo (SearchResponseMetaInfoType)

View (SearchResultsViewType)

Result (SearchResultType)

The SearchResult contains the actual result as a Location object together with information on how good the result matches the search request.

MatchQuality (LocationMatchQualityType)

MatchQuality provides detailed information about the match quality of a result at attribute level. Match quality is a value between 0.0 and 1.0. 1.0 represents a 100% match.

ParsedRequest (ParsedRequestType)

ParsedRequest shows how the various components of the request were derived from search terms.

Location (LocationType)

The location type refers to a physical location including the physical extent. A location can be referenced either by Location ID or by specifying the address.

Note: Depending on the search scenario, some sub elements might be omitted.

MapReference (MapReferenceType)

Reference to a Map Object

Address (AddressType)

Address record of a Location. Attributes are normalized to US feature names and can be mapped to the local feature levels (for example, State matches "Bundesland" in Germany) using mapping tables.

Address Details (AddressDetailsType)

The address details type provides additional information about the address. The names for address elements are listed together with the language information for this name.

Address Names (AddressNamesType)

Additional information about the address. Address information in all primary languages for bi-lingual regions. Currently limited to Spain. In Spain, some regions have multiple primary languages such as Spanish, Catalan, Basque, or Galician.

Street Details (StreetDetailsType)

The Street Details type decomposes the street name into its name parts like the base name, the street type, etc.

Distance Marker (DistanceMarkerType)

Distance Markers are sequentially numbered markers placed along roads at regular intervals that serve as reference location signs.

Admin Info (AdminInfoType)

The Admin Info type provides additional information about an administrative area covering country or state meta information like the timezone or the currency used.

Timezone (TimezoneType)

The Timezone type provides detailed time zone information including offsets and daylight savings.