Migrate Reverse Geocoding Requests

This section covers the actions that must be taken to migrate a HERE Geocoder API Reverse Geocoding request to a GS7 Reverse Geocode request.

For more details about the types or specification of parameters, see the Developer Guide.

Base URL, Version, Resource

Parameter HERE Geocoder API GS7
Base URL https://reverse.geocoder.api.here.com https://revgeocode.search.hereapi.com
Version /6.2 /v1
Resource / Endpoint /reversegeocode /revgeocode
Format specifier .xml -
.json -

HERE Geocoder API supports XML and JSON output formats. HERE Geocoding and Search v7 supports JSON output format only. The format specifier is therefore not required and must be omitted.

Query parameters

HERE Geocoder API GS7 comment
language lang List of languages is not supported.
maxresult limit GS7 does not have the concept of multiple response pages. GS7 limit parameter limits total number of the results.
politicalview politicalview GS7 politicalview parameter accepts all uppercase single ISO 3166-1 alpha-3 country codes. The complete list of currently supported political views can be found at Supported Political Views. For any valid 3 letter country code, for which HERE Geocoding and Search does not have dedicated political view, it falls back to the default view.
prox at or in=circle GS7 at parameter does not support radius. Alternatively a circular spatial filter (in=circle:lat,lon;rad) can be used.

Response attributes

HERE Geocoder API GS7 comment
View.Result[].Distance items[].distance
View.Result[].MatchLevel items[].resultType extended with one of: items[].addressBlockType, items[].localityType, items[].administrativeAreaType For details, see result types. Note, that GS7 /revgeocode also returns place results.
View.Result[].MatchType items[].houseNumberType For details, see result types.
View.Result[].Location.LocationId items[].id The location id of HERE Geocoder API and id of GS7 have different formats and are not compatible.
View.Result[].Location.LocationType items.categories[] Location types: area and address are removed as redundant. Location type distanceMarker is not supported. Other location types are covered by place category information. For more details, see the Places Category system.
View.Result[].Location.Name items.title GS7 field title contains the localized display name of this result item. In case of place result, it contains the place name. In case of address results, it contains the localized form of the address.
View.Result[].Location. DisplayPosition.Latitude items[].address.position.lat
View.Result[].Location. DisplayPosition.Longitude items[].address.position.lng
View.Result[].Location. NavigationPosition.Latitude items[].address.access.lat GS7 returns access position only if the result has access point different from the position point.
View.Result[].Location. NavigationPosition.Longitude items[].address.access.lng GS7 returns access position only if the result has access point different from the position point.
View.Result[].Location.MapView items[].mapView The data format has changed. For more details, see the API Reference. Note that place results do not have map view.
View.Result[].Location. Address.Label items[].address.label
View.Result[].Location. Address.Country items[].address.countryCode GS7 returns country name in the countryName field and country code in countryCode field.
View.Result[].Location. Address.State items[].address.state, items[].address.stateCode GS7 returns state name in the state field and state code, where commonly used, in stateCode field.
View.Result[].Location. Address.County items[].address.county, items[].address.countyCode GS7 returns county name in the county field and county code, where commonly used, in countyCode field.
View.Result[].Location. Address.City items[].address.city
View.Result[].Location. Address.District items[].address.district
View.Result[].Location. Address.Subdistrict items[].address.subdistrict
View.Result[].Location. Address.Street items[].address.street Always contains exactly one street name. GS7 /revgeocode does not support street intersection results.
View.Result[].Location. Address.HouseNumber items[].address.houseNumber
View.Result[].Location. Address.PostalCode items[].address.postalCode
View.Result[].Location.Address .AdditionalData[CountryName] items[].address.countryName GS7 returns country name in the countryName field and country code in countryCode field.
View.Result[].Location.Address .AdditionalData[StateName] items[].address.state GS7 returns state name in the state field and state code, where commonly used, in stateCode field.
View.Result[].Location.Address .AdditionalData[CountyName] items[].address.county GS7 returns county name in the county field and county code, where commonly used, in countyCode field.
View.Result[].Place items[] GS7 /geocode also returns place results. For details, see result types.

Currently not supported

The following query parameters are currently not supported in GS7 Reverse Geocode service:

HERE Geocoder API comment
additionaldata=AdditionalAddressProvider
additionaldata=AddressRangeSqueezeFactor
additionaldata=AddressRangeSqueezeOffset
additionaldata=Country2
additionaldata=CrossingStreets
additionaldata=FlexibleAdminValues N/A
additionaldata=HouseNumberMode N/A
additionaldata=IncludeChildPOIs
additionaldata=IncludeDistanceMarkers
additionaldata=IncludeMicroPointAddresses N/A
additionaldata=IncludeRoutingInformation
additionaldata=IncludeShapeLevel
additionaldata=IncludeZipAddOn GS7 /revgeocode always adds the USA ZIP+4 postal code extension where available and applicable to the ZIP code.
additionaldata=IntersectionSnapTolerance
additionaldata=NormalizeNames N/A
additionaldata=PreserveUnitDesignators N/A
additionaldata=RestrictLevel
additionaldata=SuppressStreetType
addressattributes GS7 /revgeocode has fixed set of the address attributes. Included: country, state, county, city, district, subdistrict, street, houseNumber, postalCode; country, state and county names from additionalData. Not included: addressLines; other elements of additionalData.
app_code GS7 authentication does not support the app_id/app_code method. For the available authentication options, see the Identity & Access Management Developer Guide.
app_id GS7 authentication does not support the app_id/app_code method. For the available authentication optionsy, see the Identity & Access Management Developer Guide.
country GS7 /revgeocode does not support result filtering by country code.
jsonattributes
jsoncallback
level
locationattributes.address (ar) GS7 /revgeocode results always contain address information.
locationattributes.mapReference (mr) GS7 /revgeocode does not support map reference information.
locationattributes.mapView (mv) GS7 /revgeocode results always contain mapview information, except for place results.
locationattributes.addressDetails (dt) GS7 /revgeocode does not support address details information.
locationattributes.streetDetails (sd) GS7 /revgeocode does not support street details information.
locationattributes.additionalData (ad) GS7 /revgeocode does not support location additional data (ExtendedTopLeftLatitude, ExtendedTopLeftLongitude, ExtendedBottomRightLatitude, ExtendedBottomRightLongitude, additionalAddressProvider).
locationattributes.adminIds (ai) GS7 /revgeocode does not provide administrative IDs in results.
locationattributes.linkInfo (li) GS7 /revgeocode does not provide link information in results.
locationattributes.adminInfo (in) GS7 /revgeocode does not provide any additional administrative information in results.
locationattributes.timeZone (tz) GS7 /revgeocode does not provide time zone information in results.
locationattributes.addressNamesBilingual (nb) GS7 /revgeocode does not provide bilingual address names in results.
locationattributes.related.nearByAddress (rn) GS7 /revgeocode does not provide nearby locations in results.
locationattributes.all
locationattributes.none
minresult
mode
pageinformation GS7 does not have the concept of multiple response pages. The limit parameter limits total number of the results.
pos
responseattributes.performedSearch (ps) GS7 /revgeocode has fixed set of the response attributes. Performed search information is not supported.
responseattributes.matchQuality (mq) GS7 /revgeocode has fixed set of the response attributes. Match quality values are included in fieldScore.
responseattributes.matchType (mt) GS7 /revgeocode has fixed set of the response attributes. Match type is included in houseNumberType.
responseattributes.matchCode (mc) GS7 /geocrevgeocodeode has fixed set of the response attributes. Match code is not supported.
responseattributes.parsedRequest (pr) GS7 /revgeocode has fixed set of the response attributes. Parsed request information is not supported.
responseattributes.all GS7 /revgeocode has fixed set of the response attributes.
responseattributes.none GS7 /revgeocode has fixed set of the response attributes.
sortby
strictlanguagemode
token For more information, see the Identity & Access Management Developer Guide.

The following response attributes are currently not returned by GS7 Reverse Geocode service:

HERE Geocoder API comment
MetaInfo GS7 response does not include metainfo (RequestId, Timestamp, NextPageInformation, PreviousPageInformation, request AdditionalData).
View GS7 response does not have this additional level above the result items list.
View.PerformedSearch
View.Result[].Relevance GS7 /revgeocode results do not contain scoring information because they are not relevant for Reverse Geocoding.
View.Result[].Direction
View.Result[].MatchQuality GS7 /revgeocode results do not contain scoring information because they are not relevant for Reverse Geocoding.
View.Result[].MatchCode
View.Result[].ParsedRequest
View.Result[].Location.Shape
View.Result[].Location. Address.Building GS7 /revgeocode does not support building names.
View.Result[].Location. Address.DistanceMarker GS7 /revgeocode does not support distance markers.
View.Result[].Location. Address. AddressLine
View.Result[].Location.Address .AdditionalData[CrossingStreet0] GS7 /revgeocode does not support street intersections.
View.Result[].Location.Address .AdditionalData[CrossingStreet1] GS7 /revgeocode does not support street intersections.
View.Result[].Location.Address .AdditionalData[Country2]
View.Result[].Location.Address .AdditionalData[<secondary address units>] N/A
View.Result[].Location.Address .AdditionalData[PostalCodeType]
View.Result[].Location. AddressDetails.CountryCode GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.Country GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.State GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.County GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.City GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.District GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.Street GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.StreetDetails GS7 /revgeocode does not support street details information.
View.Result[].Location. AddressDetails.HouseNumber GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.PostalCode GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressDetails.Building GS7 /revgeocode does not support address details information.
View.Result[].Location. AddressNames GS7 /revgeocode does not return additional address names.
View.Result[].Location.MapReference GS7 /revgeocode does not return map reference.
View.Result[].Location.LinkInfo GS7 /revgeocode does not include link information into the response.
View.Result[].Location.AdminInfo GS7 /revgeocode does not include admin information into the response.
View.Result[].Location.Related GS7 /revgeocode does not support related locations.
View.Result[].Location. AdditionalData GS7 /revgeocode does not support location additional data (ExtendedTopLeftLatitude, ExtendedTopLeftLongitude, ExtendedBottomRightLatitude, ExtendedBottomRightLongitude, additionalAddressProvider).
View.Result[].AdditionalData [houseNumberFallback] N/A
View.Result[].AdditionalData [houseNumberFallbackDifference] N/A
View.Result[].AdditionalData [houseNumberExtrapolation] N/A
View.Result[].AdditionalData [houseNumberExtrapolationDistance] N/A
View.Result[].AdditionalData [houseNumberExtrapolationDifference] N/A

results matching ""

    No results matching ""