Short time tickets

Ticket management is a centralized system that stores and organizes all short time ticket data in one location.

All external providers should update their ticket data in real-time to ensure that the ticket management system has the most up-to-date information.

POST /api/v1/actions/tickets

Create or update ticket

This is the endpoint to create or update a ticket in our system.

When at ticket is created or updated in your system, send a request to this endpoint with the ticket details.

Headers

  • Name
    Authorization
    Type
    Bearer
    Description

    Apply your authentication token here.

  • Name
    Accept
    Type
    application/json
    Description

    Tell the server that you want to receive JSON responses.

Parameters

  • Name
    eventType
    Type
    string
    Required
    Description

    The type of event for the ticket

    Possible values
    CreateOrUpdate
  • Name
    ticketId
    Type
    string
    Required
    Description

    Your unique identifier for the ticket.

  • Name
    parkingLotId
    Type
    int
    Required
    Description

    Our unique identifier for the parking lot where the ticket is issued.

  • Name
    startDate
    Type
    string<date-time>
    Required
    Description

    Start date and time of the ticket in ISO 8601 format.

  • Name
    endDate
    Type
    string<date-time>
    Description

    End date and time of the ticket in ISO 8601 format.

  • Name
    licenseNumber
    Type
    string
    Required
    Description

    License plate number of the vehicle

  • Name
    ticketCost
    Type
    object
    Description

    Array of days with start and end times for the permit

    • Name
      amountInclVat
      Type
      int
      Description

      The total amount of the ticket including VAT in cents

    • Name
      vatRate
      Type
      int
      Description

      VAT rate for the ticket

    • Name
      currencyCode
      Type
      string
      Description

      The currency code for the ticket. For example SEK.

Request Example 

curl -X POST 'https://falun.parkeraisverige.com/api/v1/actions/tickets' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "eventType": "CreateOrUpdate",
    "ticketId": "01985f6f-eafd-7203-b14b-aad5c6c1e253",
    "parkingLotId": 12,
    "startDate": "2023-10-01T12:00:00Z",
    "endDate": "2023-10-01T12:00:00Z",
    "licenseNumber": "ABC123",
    "ticketCost": {
        "amountInclVat": 12000,
        "vatRate": 25,
        "currencyCode": "SEK"
    }
}'

2xx Successful response 

[]

3xx Redirect

You have missed the Accept header in your request

401 Unauthorized

Your token is not provided

403 Forbidden

You dont have access to this action

5xx Server error

This is on us
POST /api/v1/actions/tickets

Cancel a ticket

Sometimes you need to cancel a ticket that was created or updated in our system.

When this happens, send a request to this endpoint with the ticket details and the event type set to TicketCanceled.

Headers

  • Name
    Authorization
    Type
    Bearer
    Description

    Apply your authentication token here.

  • Name
    Accept
    Type
    application/json
    Description

    Tell the server that you want to receive JSON responses.

Parameters

  • Name
    eventType
    Type
    string
    Required
    Description

    The type of event for the ticket

    Possible values
    TicketCanceled
  • Name
    ticketId
    Type
    string
    Required
    Description

    Your unique identifier for the ticket.

Request Example 

curl -X POST 'https://falun.parkeraisverige.com/api/v1/actions/tickets' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "eventType": "TicketCanceled",
    "ticketId": "01985f6f-eafd-7203-b14b-aad5c6c1e253"
}'

2xx Successful response 

[]

3xx Redirect

You have missed the Accept header in your request

401 Unauthorized

Your token is not provided

403 Forbidden

You dont have access to this action

5xx Server error

This is on us
GET /api/v1/actions/tickets

List your tickets

To retrieve all your tickets in a paginated list.

Headers

  • Name
    Authorization
    Type
    Bearer
    Description

    Apply your authentication token here.

  • Name
    Accept
    Type
    application/json
    Description

    Tell the server that you want to receive JSON responses.

Parameters

  • Name
    page
    Type
    int
    Description

    The page of the pagination

Request Example 

curl -X GET 'https://falun.parkeraisverige.com/api/v1/actions/tickets' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \

2xx Successful response 

{
  "status": "ok",
  "data": [
    {
      "zoneCode": 123,
      "parkingLotId": 2,
      "licenseNumber": "ABC123",
      "ticketId": "ticket-id",
      "startDate": "2025-02-10T12:00:00+01:00",
      "endDate": "2025-02-10T15:20:00+01:00",
      "ticketCost": {
        "amountInclVat": 6100,
        "vatRate": 25,
        "currencyCode": "SEK"
      },
      "createdAt": 1764831572,
      "updatedAt": 1764831572
    }
  ]
}

401 Unauthorized

Your token is not provided

403 Forbidden

You dont have access to this action

5xx Server error

This is on us