Migrate Browse Requests

This section covers the actions that must be taken to migrate a Places API Browse or Places API Browse By Corridor (deprecated) request to a GS7 Browse request.

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

Base URL, Version, Resource

Parameter Places API GS7
Public/Automotive Base URL https://places.ls.hereapi.com https://browse.search.hereapi.com
Public Legacy Base URL https://places.ls.hereapi.com https://browse.search.hereapi.com
Public Automotive Base URL https://places.ls.hereapi.com https://browse.search.hereapi.com
Version /places/v1 /v1
Resource / Endpoint /browse
/browse/by-corridor
/browse

Query flow

Places API Browse (and Browse By Corridor) result items are Place object links, of type urn:nlp-types:place. Applications needing to discriminate the different kind of Search results are using either the category.id or the categories[].id attribute. GS7 Discover resultType response element can be used instead. More details are to be found in the Result Types page

Places API applications retrieving the additional details of Place Media types through the href attribute
can retrieve those details on GS7 using the Lookup service with the id response element returned by the Browse Service. Chapter Place Details describes how Place Media types attributes map to those of a GS7 Lookup result.

Query parameters

Places API GS7 Comment
q name
Accept-Language lang Multiple values are currently not supported.
See Accept-Language header chapter
at
Geolocation
at cgen and u sub-parameters currently not supported.
See Location Context for more details.
in in cgen and u sub-parameters currently not supported.
See Location Context for more details.
size limit
route route GS7 routes need to be encoded as "HERE flexible-polyline". CW, HW, DW are currently not supported.
See Route And Compressed Route for more details
compressedRoute route GS7 routes need to be encoded as "HERE flexible-polyline". .C, .H, .D are currently not supported.
See Route And Compressed Route for more details
cs=pds Not necessary on GS7: GS7 supports by default cs=pds, the more granular places categories.
cat
(without cs=pds)
categories
urgency=1.0 Not necessary on GS7: GS7 distances are per default for an urgency of 1.0, i.e. calculated from the at position value. Check Route and Compressed Route chapter for more details.
tf=plain Not necessary on GS7: GS7 supports per default this label formatting mode.
show_refs=pvid
show_refs=tripadvisor
show_refs=yelp
Not necessary on GS7: GS7 returns Core, Yelp and Tripadvisor ids in the references response element by default.

Search Media Type

Places API GS7 Comments
results GS7 does not currently support pagination.
search GS7 does not currently return a search location context that the service has chosen for the query.

Search Results Media Type

Places API GS7 Comments
previous, next, offset GS7 does not currently supports pagination.
items items
title title
highlightedTitle
highlightedVicinity
Not returned.
Highlighting is supported in GS7 through string indices.
position[0]
position[1]
position.lat
position.lon
Places API GS7 Comments
position[0]
position[1]
position.lat
position.lon
title title
id id
categories[].id
categories[].title
(when id:xxx-xxxx-xxxx)
categories[].id
categories[].name
In GS7, the primary category object has primary field set to true.
categories[].id
categories[].title
(when id:xxx-xxxx)
foodTypes[].id
foodTypes[].name
In GS7, the primary cuisine object has primary field set to true.
type The concept of Media type is not supported. resultType field should be used to identify the type of the result.
href id See below Query flow
tags[].id foodTypes
bbox[0]
bbox[1]
bbox[2]
bbox[3]
mapView.west
mapView.south
mapView.east
mapView.north
distance distance
address.text address.label
address.house address.houseNumber
address.street address.street
address.postalCode address.postalCode
address.district address.district
address.city address.city
address.county address.county
address.state address.state
address.stateCode address.stateCode
address.country address.countryName
address.countryCode address.countryCode
contacts.phone[].value contacts[].phone[].value
contacts.website[].value contacts[].www[].value
contacts.fax[].value contacts[].fax[].value
contacts.email[].value contacts[].email[].value
references references Places API and GS7 structure the references differently.
access[0].position[0] access[0].lat
access[0].position[1] access[0].lon
openingHours openingHours[] GS7 supports multiple opening hours of same structure as Places API
phonemes phonemes
chainIds chains[].id
chains[].id chains[].id

Currently not supported

Following query parameters or headers are currently not supported in GS7 Browse service:

Places API Comment
type The concept of Media type is not supported. resultType field should be used to identify the type of the result.
name
cat
(without cs=pds)
Cuisines not supported.
result_types
X-Map-Viewport
cs=places,cuisines Not supported.
GS7 only supports the more granular places categories.
See Category Systems for more details.
urgency=0.0
tf=html
show_refs=venues*
show_refs=facebook
show_content
attributes
expand_prefix

The following Places API attributes are currently not returned in GS7 Browse service:

Places API Comments
averageRating
category non-PDS categories are currently not supported
categories.href
categories.type
categories.system
contacts.phone[].label
contacts.website[].label
contacts.fax[].label
contacts.email[].label
icon
vicinity Currently not supported. address.label could be considered as a replacement.
address.level
address.building
address.areas
address.regions
having
tags non-PDS cuisines are currently not supported. Check Category Systems for more details.
authoritative
access[].accessType GS7 does not currently support access types
access[1:].position GS7 currently only supports one access position per result.
teaser
chains[].names
alternativeNames
attributes

results matching ""

    No results matching ""