APT.MobileAPI Transaction Events

If your solution implements the identifier based 'frictionless' parking element of the APT.MobileAPI, you are required to subscribe to the api/TransactionMonitor WebSocket to receive Transaction Events. If a Transaction Event occurs during a period where you are not subscribed to the WebSocket it will be queued for re-transmission.

TransactionStarted

Resource Description

Name	Description	Type	Additional information
FacilityNo	The facility number of the entry carpark	integer	None.
CarparkNo	The carpark number of the entry carpark	integer	None.
TicketNo	The complete parking ticket number (License plate no. or QR barcode text)	string	None.
TicketType	The type of identifier. 4=License Plate, 5=Barcode	unsigned integer	None.
ReferenceNo	The reference no for this identifier	string	None.
StartTime	The time of entry into the carpark	date	None.
EventID	The unique identifier for this event	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityNo": 1,
  "CarparkNo": 2,
  "TicketNo": "sample string 3",
  "TicketType": 4,
  "ReferenceNo": "sample string 5",
  "StartTime": "2020-06-24T14:59:53Z",
  "EventID": "sample string 7"
}

TransactionCompleted

Resource Description

Name	Description	Type	Additional information
FacilityNo	The facility number of the payment carpark	integer	None.
CarparkNo	The carpark number of the payment carpark	integer	None.
TicketNo	The complete parking ticket number (License plate no. or QR barcode text)	string	None.
TicketType	The type of identifier. 4=License Plate, 5=Barcode	unsigned integer	None.
ReferenceNo	The reference no for this identifier	string	None.
CompletionTime	The time of completion	date	None.
RateNo	The rate number used for calculation	unsigned integer	None.
ParkingDuration	The duration of the current parking transaction in minutes	integer	None.
Amount	The amount due for payment	decimal number	None.
EventID	The unique identifier for this event	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FacilityNo": 1,
  "CarparkNo": 2,
  "TicketNo": "sample string 3",
  "TicketType": 4,
  "ReferenceNo": "sample string 5",
  "CompletionTime": "2020-06-24T14:59:53Z",
  "RateNo": 7,
  "ParkingDuration": 8,
  "Amount": 9.1,
  "EventID": "sample string 10"
}

Heartbeat

Resource Description

Name	Description	Type	Additional information
Heartbeat	Heartbeat timestamp	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Heatbeat": "2020-06-24T14:59:53Z"
}