API documentation

Get PSCS V1

GET /api/order_pscs

Include access_token in HTTP header:

Authorization: Bearer 09ba487fc3df...

Description

This web service returns all the pscs

Response

Status Code: 200 if OK

[
  {
    "created_at": "2017-06-29T12:34:37Z",
    "currency": "RON",
    "zone": {
      "name": "Cluj-Napoca Iulius Mall",
      "city": "Cluj-Napoca",
      "street": "A V Voievod"
    }
  }
]

Response parameters

Parameter name Parameter type Description
created_at datetime datetime when pscs was created
currency string currency iso_code of the order_pscs
zone object object containing the info about zone
zone/name string name of the zone
zone/city string city of the zone location
zone/street string street name of the zone location

Status Code: 401 if request access token not ok


Get PSCS V3

GET /api/order_pscs

Include access_token and version in HTTP headers:

Authorization: Bearer 09ba487fc3df...
Accept: application/vnd.parkingplus.v3+json

Description

Same as for v1.

Response

Status Code: 200 if OK

{
    "current_page": 1,
    "total_entries": 49,
    "total_pages": 5,
    "order_pscs": [
        {
            "id": 244,
            "total_duration": 60,
            "start_time": "2017-06-23 15:13:00",
            "end_time": "2017-06-23 16:13:00",
            "total_amount": "1.0",
            "zone": {
                "id": 2,
                "name": "Cluj-Napoca Zone 2",
                "price": "1.0",
                "price_unit": "hour",
                "currency": "RON"
            },
            "car": {
                "id": 12,
                "plate_number": "SM23PRB"
            }
        }
    ]
}

Response parameters

Parameter name Parameter type Description
current_page int current page number
total_entries int number of pscs
total_pages int number of total pages
order_pscs list of objects list of pscs objects
id int id of the pscs
total_duration int duration for the parking in minutes
start_time datetime parking start time (local time of Zone)
end_time datetime parking end time (local time of Zone)
total_amount string price of the parking
zone object object containing the info about zone
zone/id int id of the zone
zone/name string name of the zone
zone/price string price per price_unit for the zone
zone/price_unit string time unit for zone/price (hour/minute)
zone/currency string currency iso code of zone
car object object containing the info about car
car/id int id of the car
car/plate_number string plate number of car

Status Codes: 401 the same as for v1