API documentation

Home Get application settings (GET /api/app_settings) User Account web services

Login (POST /api/oauth/token or POST /api/car_driver/fo_users/logins/facebook) Login v2 (POST /api/car_driver/token or POST /api/car_driver/fo_users/logins/facebook2) Registration (POST /api/car_driver) Forgot Password (POST /api/forgotpassword) Update Account (PATCH /api/car_driver) View Account (GET /api/car_driver/edit)

Parking information web services

Get Parkings (GET /api/parkings) Get parking spaces (GET /api/parkings/{parking_id}/parking_spaces) Set favorite parking (POST /api/parkings/set_favorite) Get Suggested Parkings (GET /api/parkings/suggest)

Support and feedback

Get support types (GET /api/support/new) Send support message (POST /api/support) Send Feedback message (POST /api/feedback)

Payment web services

Get ParkingLot Orders (GET /api/order_pscs) Get Zone and Car info (GET /api/payment/information) Get Zone information (GET /api/zones/:id) Create ParkingLot payment (POST /api/order_pscs) Update ParkingLot payment (PATCH /api/order_pscs/order_id) Get payment status (GET /api/payment/status) Send mobilPay return errors (POST /api/mobil_pay/return_error) Get cards list (GET /api/car_driver/cards) Add Card (GET /api/car_driver/cards/new) Update Card (PATCH/PUT /api/car_driver/cards/:id) Delete Card (DELETE /api/car_driver/cards/:id) Set card as default (PATCH /api/car_driver/cards/:id/set_default)

Cars web services

Get All cars for user (GET /api/cars) Add new car (POST /api/cars) Set default car (POST /api/cars/set_default) Delete car (DELETE /api/cars)

Find my car web services

Get Parked car location (GET /api/car_driver/car_location) Set car location (POST /api/car_driver/car_location) Delete car location (DELETE /api/car_driver/car_location)

Bookings web services

Create Booking with Payment (POST /api/car_driver/smart_keys/create_booking) Create Booking without Payment (POST /api/car_driver/smart_keys/create_booking) Confirm Booking (PUT /api/car_driver/smart_keys/:id/confirm) Get All available parkings in zone (GET /api/car_driver/bookings/available_parkings) Check Parking Availability (GET /api/car_driver/bookings/parking_availability) Get all bookings (GET /api/car_driver/bookings?local_time=2015-11-23T10:40:00Z) Get paid bookings (GET /api/car_driver/bookings/paid?local_time=2015-11-23T10:40:00Z) Get booking (GET /api/car_driver/bookings/59)

Parking sessions web services

Create Parking Session (POST /api/car_driver/parking_sessions) Current Parking Session (GET /api/car_driver/parking_sessions/current) Parking Session Incident (POST /api/car_driver/parking_sessions/incident) Finalize Parking Session (PATCH /api/car_driver/parking_sessions/:id/ finalize) Get Parking Session Transactions (GET /api/car_driver/parking_session_transactions)

Smart Access Box web services

Get smart keys (GET /api/car_driver/smart_keys) Get Smart Key access_command (GET /api/car_driver/smart_keys/:id/access_command) Create Invite (POST /api/car_driver/invitations) Get Parkings where user is Parking Owner(GET /api/car_driver/secured_parkings) Get all requests on parking (GET /api/car_driver/requests) Create Request(POST /api/car_driver/requests) Accept Deny Request (POST /api/car_driver/smart_keys/{request_id}/activate) Get Battery Request (GET /api/car_driver/secured_parkings/:id/battery_command) Decrypt Get Battery response (GET /api/car_driver/secured_parkings/:id/battery_response) Get GetTime command (GET /api/car_driver/secured_parkings/:id/time_command) Decrypt GetTime command (GET /api/car_driver/secured_parkings/:id/time_response) Get SetTime command(GET /api/car_driver/secured_parkings/:id/set_time_command) Decrypt SetTime response(GET /api/car_driver/secured_parkings/:id/set_time_response) Get All Access Logs(GET /api/box_logs) Send Box logs(POST /api/box_logs)

Equipments web services

Get Equipment details (GET /api/equipments/:id)

Parking Session Incident V1

DEPRECATED WS, it will be removed in the next version o API. Use the V2 instead

POST /api/car_driver/parking_sessions/incident

Include access_token in HTTP header:

Authorization: Bearer 09ba487fc3df...

Description

This web service reports incidents with PayPerUse by creating a SupportEntry.

REQUEST PARAMETERS

Parameter name	Parameter type	Description
type	string	one of 'entrance_time', 'entrance_tries', 'exit_time' or 'exit_tries'

{
  "type" : "entrance_time"
}

Response

Status Code: 201 if OK

{}

Status Code: 401 if request access token not ok

Status Code: 422 if there were errors (messages included in body)

Parking Session Incident V2

POST /api/car_driver/parking_sessions/incident

Include access_token and version name in HTTP header:

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

Description

This web service reports incidents with PayPerUse by creating a SupportEntry.

REQUEST PARAMETERS

Parameter name	Parameter type	Description
type	string	one of 'entrance_tries', 'exit_tries' or 'failed_payment'
parking_session_id	int	id of the parking session involved in the incident
payment_id	int	id of the payment involved in the incident

{
  "type" : "entrance_tries",
  "parking_session_id" : 10,
  "payment_id" : 179
}

Response

Status Code: 201 if OK

{}

API documentation

Parking Session Incident V1

POST /api/car_driver/parking_sessions/incident

Description

REQUEST PARAMETERS

Response

Status Code: 201 if OK

Status Code: 401 if request access token not ok

Status Code: 422 if there were errors (messages included in body)

Parking Session Incident V2

POST /api/car_driver/parking_sessions/incident

Description

REQUEST PARAMETERS

Response

Status Code: 201 if OK

Status Code: 401 if request access token not ok

Status Code: 422 if there were errors (messages included in body)

Status Code: 404 if parking_session does not exist in DB