Ticket Managements
This section is used for incoming webhooks from the ticket management system. For tickets to be stored in our system.
Every request requires authentication.
The TicketManagement model
Properties
-
- Name
eventType
- Type
- string
- Description
-
The type of event that has occurred.
- Possible values
- TicketCreated TicketStopped TicketMoved TicketCanceled
-
- Name
ticketId
- Type
- string
- Description
-
Your unique identifier for the ticket.
-
- Name
zoneCode
- Type
- int
- Description
-
The zone code for the ticket.
-
- Name
startDate
- Type
- string
- Description
-
The start date for the ticket.
-
- Name
endDate
- Type
- string
- Description
-
The end date for the ticket.
-
- Name
licenseNumber
- Type
- string
- Description
-
The license number for the ticket.
-
- Name
ticketCost.amountInclVat
- Type
- int
- Description
-
The amount in cents including vat.
-
- Name
ticketCost.vatRate
- Type
- int
- Description
-
The vat rate for the ticket.
-
- Name
ticketCost.currencyCode
- Type
- string
- Description
-
The currency code for the ticket. For example SEK.
JSON Resource
{
"eventType": "TicketMoved",
"ticketId": 71963,
"zoneCode": 1211,
"startDate": "2025-03-11T04:37:16+00:00",
"endDate": "2025-03-11T15:45:16+00:00",
"licenseNumber": "EGY918",
"ticketCost": {
"amountInclVat": 3052,
"vatRate": 25,
"currencyCode": "SEK"
}
}
Create a ticket
Authentication
-
- Type
Token
- Description
-
Authorization: Bearer [token]
-
- Type
Basic
- Description
-
Authorization: Basic base64([username]:[password])
Parameters
-
- Name
eventType
- Type
- string
- Description
-
The type of event that has occurred.
- Possible values
- TicketCreated
-
- Name
ticketId
- Type
- string
- Description
-
Your unique identifier for the ticket.
-
- Name
zoneCode
- Type
- int
- Description
-
The zone code for the ticket.
-
- Name
parkingLotId
- Type
- int
- nullable
- Description
-
The parking lot id in our system.
-
- Name
startDate
- Type
- string
- Description
-
The start date for the ticket.
-
- Name
endDate
- Type
- string
- nullable
- Description
-
The end date for the ticket.
-
- Name
licenseNumber
- Type
- string
- Description
-
The license number for the ticket.
-
- Name
ticketCost
- Type
- object
- Description
-
The price information for the ticket.
-
- Name
ticketCost.amountInclVat
- Type
- int
- nullable
- Description
-
The amount in cents including vat.
-
- Name
ticketCost.vatRate
- Type
- int
- nullable
- Description
-
The vat rate for the ticket.
-
- Name
ticketCost.currencyCode
- Type
- string
- nullable
- Description
-
The currency code for the ticket. For example SEK.
Request example
curl --request POST \
--url https://api.{tenant}.parkeraisverige.com/api/v1/actions/tickets \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"eventType": "TicketCreated",
"ticketId": "999",
"zoneCode": "1234",
"parkingLotId": "2345",
"startDate": "2025-03-11T04:50:17+00:00",
"endDate": "2025-03-11T14:24:17+00:00",
"licenseNumber": "ABC123",
"ticketCost": {
"amountInclVat": 1000,
"vatRate": 25,
"currencyCode": "SEK"
}
}'
Response
[]
Update a ticket
This endpoint should be used when a ticket is updated. For example, when the ticket is stopped.
Authentication
-
- Type
Token
- Description
-
Authorization: Bearer [token]
-
- Type
Basic
- Description
-
Authorization: Basic base64([username]:[password])
Parameters
-
- Name
eventType
- Type
- string
- Description
-
The type of event that has occurred.
- Possible values
- TicketUpdated TicketStopped
-
- Name
ticketId
- Type
- string
- Description
-
Your unique identifier for the ticket.
-
- Name
zoneCode
- Type
- int
- Description
-
The zone code for the ticket.
-
- Name
parkingLotId
- Type
- int
- nullable
- Description
-
The parking lot id in our system.
-
- Name
startDate
- Type
- string
- Description
-
The start date for the ticket.
-
- Name
endDate
- Type
- string
- Description
-
The end date for the ticket.
-
- Name
licenseNumber
- Type
- string
- Description
-
The license number for the ticket.
-
- Name
ticketCost
- Type
- object
- Description
-
The price information for the ticket.
-
- Name
ticketCost.amountInclVat
- Type
- int
- Description
-
The amount in cents including vat.
-
- Name
ticketCost.vatRate
- Type
- int
- Description
-
The vat rate for the ticket.
-
- Name
ticketCost.currencyCode
- Type
- string
- Description
-
The currency code for the ticket. For example SEK.
Request example
curl --request POST \
--url https://api.{tenant}.parkeraisverige.com/api/v1/actions/tickets \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"eventType": "TicketUpdated",
"ticketId": "999",
"zoneCode": "1234",
"parkingLotId": "2345",
"startDate": "2025-03-10T20:49:17+00:00",
"endDate": "2025-03-11T11:21:17+00:00",
"licenseNumber": "ABC123",
"ticketCost": {
"amountInclVat": 1000,
"vatRate": 25,
"currencyCode": "SEK"
}
}'
Response
[]
Change registration number on a ticket
Authentication
-
- Type
Token
- Description
-
Authorization: Bearer [token]
-
- Type
Basic
- Description
-
Authorization: Basic base64([username]:[password])
Parameters
-
- Name
eventType
- Type
- string
- Description
-
The type of event that has occurred.
- Possible values
- TicketMoved
-
- Name
ticketId
- Type
- string
- Description
-
Your unique identifier for the ticket.
-
- Name
fromLicenseNumber
- Type
- string
- Description
-
The license number for the ticket.
-
- Name
toLicenseNumber
- Type
- string
- Description
-
The new license number for the ticket.
Request example
curl --request POST \
--url https://api.{tenant}.parkeraisverige.com/api/v1/actions/tickets \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"eventType": "TicketMoved",
"ticketId": "999",
"fromLicenseNumber": "ABC123",
"toLicenseNumber": "ABC124"
}'
Response
[]
Cancel a ticket
This endpoint should only be used to cancel (delete) a ticket.
Authentication
-
- Type
Token
- Description
-
Authorization: Bearer [token]
-
- Type
Basic
- Description
-
Authorization: Basic base64([username]:[password])
Parameters
-
- Name
eventType
- Type
- string
- Description
-
The type of event that has occurred.
- Possible values
- TicketCanceled
-
- Name
ticketId
- Type
- string
- Description
-
Your unique identifier for the ticket.
Request example
curl --request POST \
--url https://api.{tenant}.parkeraisverige.com/api/v1/actions/tickets \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"eventType": "TicketCanceled",
"ticketId": "999"
}'
Response
[]
Create or update ticket
This endpoint can be used if you can only use one action for both create and update. It also allows for a more flexible way to define amounts.
Authentication
-
- Type
Token
- Description
-
Authorization: Bearer [token]
-
- Type
Basic
- Description
-
Authorization: Basic base64([username]:[password])
Parameters
-
- Name
eventType
- Type
- string
- Description
-
The type of event that has occurred.
- Possible values
- CreateOrUpdate
-
- Name
ticketId
- Type
- string
- Description
-
Your unique identifier for the ticket.
-
- Name
zoneCode
- Type
- int
- Description
-
The zone code for the ticket.
-
- Name
parkingLotId
- Type
- int
- nullable
- Description
-
The parking lot id in our system.
-
- Name
startDate
- Type
- string
- Description
-
The start date for the ticket.
-
- Name
endDate
- Type
- string
- nullable
- Description
-
The end date for the ticket.
-
- Name
licenseNumber
- Type
- string
- Description
-
The license number for the ticket.
-
- Name
ticketCost
- Type
- object
- Description
-
The price information for the ticket.
-
- Name
ticketCost.amountInclVat
- Type
- int
- nullable
- Description
-
The amount in cents including vat. Can also be passed as a string 10,20 = 1020
-
- Name
ticketCost.vatRate
- Type
- int
- nullable
- Description
-
The vat rate for the ticket.
-
- Name
ticketCost.currencyCode
- Type
- string
- nullable
- Description
-
The currency code for the ticket. For example SEK.
Request example
curl --request POST \
--url https://api.{tenant}.parkeraisverige.com/api/v1/actions/tickets \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
"eventType": "CreateOrUpdate",
"ticketId": "999",
"zoneCode": "1234",
"parkingLotId": "2345",
"startDate": "2025-03-11T03:48:17+00:00",
"endDate": "2025-03-11T13:18:17+00:00",
"licenseNumber": "ABC123",
"ticketCost": {
"amountInclVat": "10,20",
"vatRate": 25,
"currencyCode": "SEK"
}
}'
Response
[]