Response items enrichment
HERE Geocoding and Search allows developers to get richer response items attributes through the addition of the request query parameter show.
The currently supported values for show are listed in the table:
show value | endpoints | maturity privilege | Description |
|---|---|---|---|
countryInfo | /geocode, /revgeocode, /lookup | GA | Add to each result item a block with the country info, such as ISO 3166-1 alpha-2 and ISO 3166-1 alpha-3 country code. |
parsing | /geocode | GA | The /geocode endpoint can provide information about how it parsed a request. Applications can use the information to decide whether a request requires further processing or not. Applications can also use the information for address cleansing, for example, to increase the Geocoder success rate and confidence level for future geocoding requests. |
phonemes | /autosuggest, /browse, /discover, /lookup | GA | Adds available phonetic details for address and place names to the response items. |
streetInfo | all | GA | Adds to each response item an additional block with the street name decomposed into its parts like the base name, the street type, etc. |
tz | all except /autocomplete | GA | Adds to result items IANA TZ time zone information. |
Example of a /lookup response with show=streetInfo,tz,phonemes:
{
"title": "Vanille Noire",
"id": "here:pds:place:250jx7ps-8f300d0f8ec60e31fb76a3d22f00f18f",
(...)
"timeZone": { "name": "Europe/Paris", "utcOffset": "+02:00" },
"phonemes": {
"placeName": [{ "value": "va|\"nij \"nwaR", "language": "fr", "preferred": true }],
"countryName": [{ "value": "\"frAns", "language": "en-GB", "preferred": true }],
"state": [{ "value": "pr@|\"vQns \"{lps \"ket \"d{|zVr", "language": "en-GB", "preferred": true }],
"county": [{ "value": "\"buS %dy \"Ron", "language": "fr", "preferred": true }],
"city": [{ "value": "mA|\"seI", "language": "en-GB", "preferred": true }],
"street": [{ "value": "\"Ry kEs|\"Ri", "language": "fr", "preferred": true }]
},
"streetInfo": [
{
"baseName": "Caisserie",
"streetType": "Rue",
"streetTypePrecedes": true,
"streetTypeAttached": false,
"language": "fr"
}
]
}