GET api/CreateSingleUseIdentifier
GET implementation of GetFacilityConfiguration
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
APIKey |
An active API Key for the APT.MobileAPI service |
string |
None. |
FacilityNo |
The facility number of the target carpark |
integer |
None. |
ValidCarparks |
The carparks available for use by the identifier |
Collection of integer |
None. |
TicketNo |
The ticket number to be used as an identifier (License plate no. or QR barcode text) |
string |
None. |
TicketType |
The type of identifier. 4=License Plate, 5=Barcode |
unsigned integer |
None. |
ProductId |
The product identifier (used to define the access rules such as valid carparks) |
string |
None. |
ValidFrom |
The time this identifier is valid from |
date |
None. |
ValidUntil |
The time this identifier is valid until |
date |
None. |
IsNeutral |
The neutral status for the identifier |
boolean |
None. |
ReferenceNo |
The reference no for this identifier. This will auto-generate if null or empty ) |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
CreateIdentifierResponseName | Description | Type | Additional information |
---|---|---|---|
FacilityNo |
The facility number of the target carpark |
integer |
None. |
TicketNo |
The ticket number to be used as an identifier (License plate no. or QR barcode text) |
string |
None. |
TicketType |
The type of identifier. 4=License Plate, 5=Barcode |
unsigned integer |
None. |
ProductId |
The product identifier (used to define the access rules such as valid carparks) |
string |
None. |
ValidFrom |
The time allowed for entry into the carpark |
date |
None. |
ValidUntil |
The time this transaction has been paid until |
date |
None. |
ReferenceNo |
The reference no for this identifier |
string |
None. |
Response Formats
application/json, text/json
{ "FacilityNo": 1, "TicketNo": "sample string 2", "TicketType": 3, "ProductId": "sample string 4", "ValidFrom": "2025-08-31T06:21:15.4240876+00:00", "ValidUntil": "2025-08-31T06:21:15.4240876+00:00", "ReferenceNo": "sample string 7" }