1. Home
  2. Bliq Park API
  3. askParkingAssistant
  1. Home
  2. Swagger API documentation
  3. askParkingAssistant

askParkingAssistant

Request format

Required parameters

Example for a minimal viable request

{
   "mapLayers":[
      "RULES",
      "PREDICTION"
   ],
   "requestType":{
      "dataType":"LastMileRoutingRequest",
      "timestampDescription":{
         "unixSeconds":1564581600
      },
      "value":{
         "departure":{
            "type":"Point",
            "coordinates":[
               10.512999,
               52.260999
            ]
         },
         "destination":{
            "type":"Point",
            "coordinates":[
               10.512625,
               52.2606285
            ]
         }
      }
   }
}

Note on fallback behavior: If requested information is not available, an empty response will be returned. 

 

Optional parameters

Example for a full request with all optional parameters

{
   "localeDefinition":{
      "contentLanguage":"EN",
      "currencyCode":"EUR",
      "unitSystem":"METRIC"
   },
   "outputFormat":"GEO_JSON",
   "mapResolutionLevel":"BLOCK",
   "mapLayers":[
      "RULES",
      "PREDICTION"
   ],
   "parkingDuration":{
      "from":{
         "unixSeconds":1565458931
      },
      "until":{
         "unixSeconds":1565498931
      }
   },
   "includeTags":[
      "FREE"
   ],
   "excludeTags":[
      "PAID"
   ],
   "timestampDescription":{
      "unixSeconds":1565458931
   },
   "requestType":{
      "dataType":"LastMileRoutingRequest",
      "timestampDescription":{
         "unixSeconds":1565458931
      },
      "value":{
         "departure":{
            "type":"Point",
            "coordinates":[
               10.512999,
               52.260999
            ]
         },
         "destination":{
            "type":"Point",
            "coordinates":[
               10.512625,
               52.2606285
            ]
         }
      }
   },
   "preferences":[
      "SHORT_WALKING_LEVEL_1"
   ]
}

Request Parameters

Name Value Type Required
localeDefinition A dictionary that specifies contentLanguage, currency and height units:

default:

“contentLanguage”: “EN”,
“currencyCode”: “EUR”,
“unitSystem”: “METRIC” (or “IMPERIAL”

for currently supported values, see here.

{String:String} no
outputFormat Specifies the output format in which the response is returned.

Allowed Values: “GEO_JSON” (default), “REGULAR_JSON”, “PREDICTION_ONLY”

Note: “PREDICTION_ONLY” is designed to retrieve occupancy values of parking areas without requesting additional overhead. It works only, when the “mapLayers” parameter is set to mapLayers=[“PREDICTION”]

String no
mapResolutionLevel Specifies the spatial resolution in which results are returned.

Allowed values are:

  • “BLOCK” (default)
  • “SIGN”
  • “HD”
String no
mapLayers A comma-separated list of map layers, which should be included in the response.

Allowed values are:

[“RULES”,”PREDICTION”,”LIVE”]

mapLayers must not be empty!

[String] yes
parkingDuration Specifies the time for which parking is required. If set, price information will return a “calculatedPrice” for the given parkingDuration. {String: Any} no
includeTags A comma-separated list of parkingAreaTags. Returned parkingArea must be flagged with these tags.

[“FREE”,”PAID”,”CUSTOMER”,”PRIVATE”]

[String] no
excludeTags A comma-separated list of parkingAreaTags. Returned parkingArea must not be flagged with these tags.

Important! excludeTags overrule includeTags in case of conflicting tags.

[“FREE”,”PAID”,”CUSTOMER”,”PRIVATE”]

[String] no
timestampDescription Dictionary to specify the time for when the results should be requested.

Allowed values:

  • “unixSeconds”: 1563008400 (default)
  • “dateString”: “2019-07-13T11:00:00+02:00”
  • “unixMilliSeconds”: 1563008400048
{String: Any} yes
departure Specifies the location of where a trip is starting.

Format: “type”: “Point”,
“coordinates”: [
10.512999,
52.260999
]

{String: Any} yes
destination Specifies the destination of a trip.

Format: “type”: “Point”,
“coordinates”: [
10.512625,
52.2606285
]

{String: Any} yes
preferences A comma-separated list of user preferences for further configuration of the parking assistants response.

Default: Empty list

 

[String] no

Response

Behavior in Free Plan

Parking Assistant is only available for users in Starter or Committed Use plans.

{ "statusMessage": "Free plan does not allow requests for use of the Parking Assistant! Please upgrade your plan within Bliq Studio Account Management (https://studio.bliq.ai/personal-account-management) or adjust your request!"}

Behavior in Starter Plan

To use Parking Assistant, you must be subscribed to Starter Plan.

For information about permitted use and display of results, see Bliq API use and display requirements.

Example for a GeoJSON Response:

{
   "type":"FeatureCollection",
   "features":[
      {
         "type":"Feature",
         "id":5771100,
         "geometry":{
            "type":"MultiPolygon",
            "coordinates":[
               [
                  [
                     [
                        10.5185003,
                        52.2548237
                     ],
                     [
                        10.5184145,
                        52.2551287
                     ],
                     [
                        10.5182052,
                        52.2556887
                     ],
                     [
                        10.5180251,
                        52.2561065
                     ],
                     [
                        10.5177886,
                        52.2565768
                     ],
                     [
                        10.5177509,
                        52.2565627
                     ],
                     [
                        10.5180356,
                        52.255977
                     ],
                     [
                        10.5181717,
                        52.2556503
                     ],
                     [
                        10.5183873,
                        52.2550954
                     ],
                     [
                        10.5184606,
                        52.254816
                     ],
                     [
                        10.5185003,
                        52.2548237
                     ]
                  ]
               ]
            ]
         },
         "properties":{
            "parkingEntity":{
               "id":5072717,
               "parkingEntityName":"Tuckermannstraße",
               "capacity":12,
               "centerPoint":{
                  "type":"Point",
                  "coordinates":[
                     10.505094300799556,
                     52.26486835536122
                  ]
               },
               "orientation":"PARALLEL",
               "parkingTags":[
                  "PAID"
               ],
               "openingHours":{
                  "schedules":[
                     {
                        "schedule":{
                           "priority":0
                        },
                        "scheduleType":"OPEN"
                     }
                  ],
                  "simpleOpeningStatus":"OPEN"
               },
               "priceInformation":{
                  "schedules":[
                     {
                        "schedule":{
                           "priority":0
                        },
                        "priceModel":{
                           "interval":1440,
                           "prices":[
                              {
                                 "currencyCode":"EUR",
                                 "price":"-1.00",
                                 "maxPrice":"100.00"
                              }
                           ]
                        }
                     }
                  ],
                  "calculatedPrice":"4.00",
                  "parkingDuration":500,
                  "simplePriceStatus":"FREE"
               },
               "occupancy":{
                  "color":"GREEN",
                  "occupancyLive":{
                     "lastUpdated":{
                        "unixSeconds":1565250329
                     },
                     "minimumOpenSpots":10,
                     "occupancyRange":{
                        "fromOpenSpots":10,
                        "toOpenSpots":20
                     }
                  },
                  "occupancyPredicted":{
                     "occupancyRange":{
                        "fromOpenSpots":10,
                        "toOpenSpots":20
                     },
                     "openSpots":10,
                     "parkingProbability":80
                  },
                  "state":"CLOSED",
                  "timestampDescription":{
                     "unixSeconds":1565250329
                  }
               }
            }
         }
      },
      {
         "type":"Feature",
         "geometry":{
            "type":"LineString",
            "coordinates":[
               [
                  10.5050943007,
                  52.2648683553
               ],
               [
                  10.5040612402,
                  52.2646045403
               ]
            ]
         },
         "properties":{
            "optimalTrip":{
               "stopoverPoints":[
                  {
                     "type":"Point",
                     "coordinates":[
                        10.516387272414523,
                        52.25602797633999
                     ]
                  },
                  {
                     "type":"Point",
                     "coordinates":[
                        10.515340111439981,
                        52.2564099
                     ]
                  }
               ],
               "parkingSituation":"INTERMEDIATE",
               "parkingAdvice":"The parking situation at your destination is intermediate, but your search time will not more than two minutes.",
               "parkingProbability":95,
               "estimatedSearchTime":{
                  "searchTimeWithParkingAssistant":300,
                  "searchTimeWithoutParkingAssistant":600
               },
               "destination":{
                  "type":"Point",
                  "coordinates":[
                     10.512625,
                     52.2606285
                  ]
               },
               "visitedParkingSpots":237
            }
         }
      }
   ]
}

Explanation: The response contains geometric features, where one of them is the optimalTrip and the rest of them are drive-by-areas. The optimalTrip feature shows the route as a LineString. It’s properties contain stopover-points as well as further details describing the parking situation at the destination.

The remaining features represent and contain information about regular parking entities. They may be both – on- and off-street parking entities.

Endpoint

https://api.bliq.ai:443/park/v2/askParkingAssistant

Headers

Header Description
Content-Type application/json;charset=UTF-8
apikey API key of your application. For better traceability, please use one API key per application / platform
uuid Unique identifier of your user. A uuid is required in order to avoid unintended use of the API.

Remember that the Terms of Use require compliance with all applicable laws, including regarding use of these headers. For example, in certain jurisdictions, such as Europe, there are requirements to obtain user consent before placing certain tracking devices on user devices.

Mobile SDKs

Developing on iOS or Android? If so, you are required to use our Mobile SDKs, which handle all the heavy lifting for you and don’t require you to interact with the bare API.

Updated on December 8, 2019

Was this article helpful?

Related Articles

Bitnami