Facilities
This resource retrieves a list of parking facilities.
Requests against this resource use the HTTP GET method. The search criteria are specified by means of query parameters, which must include a search geometry.
A search geometry can be one of:
- prox – a circular area defined by the coordinates of its center and a radius.
- corridor – a path defined as a set of points (latitude, longitude pairs) and a width.
- bbox – a square defined by its top left latitude and longitude and its bottom right latitude and longitude.
Request Example
The code block below shows a facility request that uses proximity (prox) to define the search area:
curl GET
https://parking-v2.cc.api.here.com/parking/facilities.json
?prox=50.70295,7.178353,5000
-H "Authorization: Bearer {YOUR_TOKEN}"
Request Parameters
The table below documents both mandatory and optional request parameters supported by this resource.
| Parameter | Required | Description |
|---|---|---|
app_id - Legacy | Yes | A-20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an |
app_code - Legacy | Yes | A-20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include an |
prox | prox, bbox or corridor must be present | A circular search area defined by the latitude and longitude of its center (compliant with WGS 84) and an integer representing the radius of the area in meters, all separated by commas. For example, Radius can be a maximum of 200 km. |
bbox | prox, bbox or corridor must be present | Bounding box defined by the latitude and longitude (compliant with WGS 84) of its top left and bottom right corners. The top left and bottom right pairs are separated by a semicolon and the latitude and longitude pairs are separated by commas. For example, one possible bounding box value is The bounding box size (width and/or high) must be no larger than 400km. |
corridor | prox, bbox or corridor must be present | A strip defined as a semicolon-separated list of points (pairs of comma-separated latitude and longitude WGS 84 compliant values) For example, Maximum corridor area is 5000 km2 Note that requests to the |
corridorwidth | No | The width of the corridor in meters. This parameter takes effect only if The maximum corridor width is 20 km. Default: 5000 meters |
arrival | No | Expected time arrival at the destination in UTC format according to ISO 8601. Note this parameter is mandatory for parking fee calculation. Example: 2015-04-02T15:40:00.000Z |
duration | No | Estimated parking duration in minutes. Min value: 1. Max value: 20160 (two weeks) Note this parameter is mandatory for parking fee calculation. |
sortkey | No | Criteria for sorting a list of search results: The possible results are:
Default: distance |
sortorder | No | The sort order in the response. The possible results are:
Default: asc |
maxresults | No | The maximum number of results a response can contain. This parameter can be used with the Default: 50 |
offset | No | A value specifying the index of the first result. The offset together with the "maxresults" value can be used to support a paging mechanism on search results. This parameter can be used with the Default: 0 |
hide | No | The comma-separated list of attribute values specifying which parking facilities must be filtered out from the result. If not specified then no filtering is applied to the result. Possible values:
|
Response to this Request
For more information on the responses to requests against the facilities resource, see Parking Facilities Response.
