Vehicle API

Available resources

• GET - check the permit and session data of a vehicle
• Error handling

Access requirements

• A valid authentication token is required to access the API. How to authenticate your application
• Access to the Vehicle API is offered as a paid service. Please contact your Autopay representative for details.

GET - Check the permit and session data for a vehicle

This method allows you to check the following: does a valid permit exist for the current vehicle, is there a running parking session tied to this permit and does the current vehicle have an in progress parking session.

Endpoint

GET https://api.autopay.io/vehicle/v1/permit

Request parameters

• The request body must be in JSON format and HTTP headers must include Content-Type: application/json.
• The HTTP headers must include a valid access token.
• The path must include vehicle registration number and zone id parameters (vehicle/v1/permit?vehicle={ABC123}&zone_id={12}). Please see the path parameters table below for more information.

Request example

GET https://api.autopay.io/vehicle/v1/permit?vehicle=123TTC&zone_id=10

Request path example with multiple zones (zone id 100 and 123)

GET https://api.autopay.io/vehicle/v1/permit?vehicle=123ABC&zone_id=100&zone_id=123

Success response

HTTP Code: 200 OK

Example success response

{
    "has_valid_permit_in_zone": false,
    "in_progress_parking_session": true,
    "in_progress_parking_start_time": "2020-03-27T09:40:29+0000",
    "in_progress_parking_session_start_time": "2020-03-27T13:12:17+0000",
    "permit_used_for_in_progress_parking_session": false,
    "is_in_profile": true,
    "is_in_profile_with_valid_payment_card": true
}

Error messages

Example error response:

{
    "error_id": "authentication_error",
    "message": "No access token present in header!"
}

Possible error id-s: