Off-Street Parking API Developer's Guide

Parking Facilities Search Example

This section provides an example of a request for a list of parking facilities.

User story

The user wants to know the locations of all parking facilities within a radius of 500 m of the center of Berlin, Germany.

Request Summary

Resource: Facilities – note that resource representation is specified via extensions .xml or .json
Parameters: prox – specifies the center (latitude and longitude) and the radius in meters (500 in this case) of the search geometry

Request example

The code block below demonstrates the complete request, specifying that the response data are to be delivered in JSON.

curl GET 
https://parking-v2.cit.cc.api.here.com/parking/facilities.json
?prox=52.51638,13.38244,500
-H "Authorization: Bearer {YOUR_TOKEN}"
      

Here is the same request indicating that the response data are to be delivered in XML:

curl GET 
https://parking-v2.cit.cc.api.here.com/parking/facilities.xml
?prox=52.51638,13.38244,500
-H "Authorization: Bearer {YOUR_TOKEN}"      
      

Response example

The response contains

  • status information about the success of the request, together with a timestamp
  • a list of facilities, represented as ParkingFacilities elements, where each facility has its own unique id, location, address information and type, and other properties as described in ParkingFacilityType

Example response in JSON format:


{
   "hasMore":false,
   "facilities":{
    "facility":[
     {
      "open24x7":true,
      "facilityDetails":{
         "openingHours":{
          "openNow": true,
          "regularOpeningHours":[
           {
            "daymask":127,
            "period":[
               {
                "from":"00:00:00",
                "to":"24:00:00"
               }
            ]
           }
          ],
          "annualOpenings":[

          ]
         },
         "driveMaxHeight":1.8,
         "facilityType":{
          "name":"Parking Facility",
          "id":"1"
         },
         "facilityOperator":"APCOA GmbH",
         "facilityLevels":2,
         "facilityInfrastructures":{
          "name":[
           "handicappedparkingspaces",
           "securitymanned",
           "elevators",
           "light"
          ]
         },
         "facilityAdministration":{
          "name":[
           "Monitored",
           "Gate"
          ]
         },
         "facilityRestrictions":{

         },
         "paymentMethods":[
          {
           "name":"Cash - EUR",
           "id":"CASH"
          }
         ]
      },
      "facilityAvailability":{
         "spacesTotal":173,
         "available":true,
         "pricing":{
          "price":[
           {
            "priceGroup":0,
            "amount":2.0,
            "currency":"EUR",
            "unit":30,
            "daymask":127,
            "minMinutes":0,
            "maxMinutes":30,
            "textRepresentation": [
              {
              "text": [
                "First 30 minutes",
                "Per 30 minutes",
                "Every day"
              ],
              "language": "en-US"
              }
            ]
           },
           {
            "priceGroup":1,
            "amount":4.0,
            "currency":"EUR",
            "unit":60,
            "daymask":127,
            "minMinutes":31,
            "maxMinutes":60,
            "textRepresentation": [
              {
              "text": [
                "Over 31 minutes",
                "Max 1 hour",
                "Per hour",
                "Every day"
              ],
              "language": "en-US"
              }
            ]
           },
           {
            "priceGroup":2,
            "amount":38.0,
            "currency":"EUR",
            "unit":1440,
            "daymask":127,
            "minMinutes":61,
            "maxMinutes":1440,
            "textRepresentation": [
              {
              "text": [
                "Over 1 hour and 1 minute",
                "Max 24 hours",
                "Per day",
                "Every day"
              ],
              "language": "en-US"
              }
            ]
           }
          ]
         },
         "lastUpdateTimestamp":"2016-06-06T06:50:31.000Z"
      },
      "address":{
         "city":"Berlin",
         "country":"DEU",
         "region":"Berlin",
         "street":"Unter den Linden",
         "streetNumber":"77",
         "postalCode":"10117"
      },
      "contacts":{
         "phone":[
          {
           "value":"+4971130570305",
           "label":"PHONE"
          }
         ]
      },
      "distance":166,
      "position":{
         "latitude":52.51631,
         "longitude":13.37999
      },
      "name":"Hotel Adlon",
      "id":"276u33db-e63737ae997c4a1ab5a19c50a63af49e",
      "lastUpdateTimestamp":"2016-05-31T01:04:46.015Z",
      "timeZone":"Europe/Berlin"
     },
     {
          ---removed to shorten document
     }
    ]
   }
}

Example response in XML format:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parking-offstreet:parkingFacilitiesResult xmlns:common="http://www.here.com/2014/02/ACS-Common" xmlns:fuel="http://www.here.com/2014/02/ACS-Fuel"
  xmlns:parking-offstreet="http://www.here.com/2014/02/ACS-Parking-Offstreet" xmlns:ev="http://www.here.com/2014/02/ACS-EV"
>
  <hasMore>false</hasMore>
  <facilities>
    <facility id="276u33db-e63737ae997c4a1ab5a19c50a63af49e" lastUpdateTimestamp="2016-05-31T01:04:46.015Z" timeZone="Europe/Berlin">
      <address>
        <city>Berlin</city>
        <country>DEU</country>
        <region>Berlin</region>
        <street>Unter den Linden</street>
        <streetNumber>77</streetNumber>
        <postalCode>10117</postalCode>
      </address>
      <contacts>
        <phone>
          <value>+4971130570305</value>
          <label>PHONE</label>
        </phone>
      </contacts>
      <distance>166</distance>
      <position>
        <latitude>52.51631</latitude>
        <longitude>13.37999</longitude>
      </position>
      <name>Hotel Adlon</name>
      <open24x7>true</open24x7>
      <facilityDetails>
        <openNow>true</openNow>
        <openingHours>
          <regularOpeningHours>
            <daymask>127</daymask>
            <period>
              <from>00:00:00</from>
              <to>24:00:00</to>
            </period>
          </regularOpeningHours>
        </openingHours>
        <driveMaxHeight>1.8</driveMaxHeight>
        <facilityType>
          <name>Parking Facility</name>
          <id>1</id>
        </facilityType>
        <facilityOperator>APCOA GmbH</facilityOperator>
        <facilityLevels>2</facilityLevels>
        <facilityInfrastructures>
          <name>handicappedparkingspaces</name>
          <name>securitymanned</name>
          <name>elevators</name>
          <name>light</name>
        </facilityInfrastructures>
        <facilityAdministration>
          <name>Monitored</name>
          <name>Gate</name>
        </facilityAdministration>
        <facilityRestrictions />
        <paymentMethods>
          <name>Cash - EUR</name>
          <id>CASH</id>
        </paymentMethods>
      </facilityDetails>
      <facilityAvailability>
        <spacesTotal>173</spacesTotal>
        <available>true</available>
        <pricing>
          <price>
            <priceGroup>0</priceGroup>
            <amount>2.0</amount>
            <currency>EUR</currency>
            <unit>30</unit>
            <daymask>127</daymask>
            <minMinutes>0</minMinutes>
            <maxMinutes>30</maxMinutes>
            <textRepresentation language="en-US">
              <text>First 30 minutes</text>
              <text>Per 30 minutes</text>
              <text>Every day</text>
            </textRepresentation>
          </price>
          <price>
            <priceGroup>1</priceGroup>
            <amount>4.0</amount>
            <currency>EUR</currency>
            <unit>60</unit>
            <daymask>127</daymask>
            <minMinutes>31</minMinutes>
            <maxMinutes>60</maxMinutes>
            <textRepresentation language="en-US">
              <text>Over 31 minutes</text>
              <text>Max 1 hour</text>
              <text>Per hour</text>
              <text>Every day</text>
            </textRepresentation>
          </price>
          <price>
            <priceGroup>2</priceGroup>
            <amount>38.0</amount>
            <currency>EUR</currency>
            <unit>1440</unit>
            <daymask>127</daymask>
            <minMinutes>61</minMinutes>
            <maxMinutes>1440</maxMinutes>
            <textRepresentation language="en-US">
              <text>Over 1 hour and 1 minute</text>
              <text>Max 24 hours</text>
              <text>Per day</text>
              <text>Every day</text>
            </textRepresentation>
          </price>
        </pricing>
        <lastUpdateTimestamp>2016-06-06T06:50:31.000Z</lastUpdateTimestamp>
      </facilityAvailability>
    </facility>
    <facility id="276u33db-4b02a2dbe7ef4fdea1d536e7608428c0" pvId="1016951408" lastUpdateTimestamp="2016-05-31T01:14:11.084Z" timeZone="Europe/Berlin">
          --- removed to shorten document
    </facility>
  </facilities>
</parking-offstreet:parkingFacilitiesResult>

For more details about responses to this type of request, see Parking Facilities Response.