POST api/ApplyPromotion
POST implementation of ApplyPromotion
Request Information
URI Parameters
None.
Body Parameters
ApplyPromotionRequest| 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. |
| TicketNo |
The complete parking ticket number |
string |
None. |
| TicketType |
The type of parking ticket. 0=Standard Ticket, 4=License Plate, 5=External Card System |
unsigned integer |
None. |
| Amount |
The amount that has been paid |
decimal number |
None. |
| AuthorisationCode |
The authorisation code |
string |
None. |
| PaymentTime |
The time payment was made |
date |
None. |
| PromotionValue |
The amount to be discounted as part of the promotion |
decimal number |
None. |
| PromotionCode |
The promotion identification code |
string |
None. |
| PromotionDescription |
A brief description of why the promotion was applied |
string |
None. |
| CustomerID | integer |
None. |
Request Formats
application/json, text/json
{
"APIKey": "sample string 1",
"FacilityNo": 2,
"TicketNo": "sample string 3",
"TicketType": 4,
"Amount": 5.1,
"AuthorisationCode": "sample string 6",
"PaymentTime": "2025-08-31T06:25:00.4891136+00:00",
"PromotionValue": 8.1,
"PromotionCode": "sample string 9",
"PromotionDescription": "sample string 10",
"CustomerID": 11
}
Response Information
Resource Description
ApplyPromotionResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| FacilityNo |
The facility number of the target carpark |
integer |
None. |
| CarparkNo |
The carpark number of the target carpark |
integer |
None. |
| TicketNo |
The complete parking ticket number |
string |
None. |
| TicketType |
The type of parking ticket. 0=Standard Ticket, 4=License Plate, 5=External Card System |
unsigned integer |
None. |
| Amount |
The amount that has been paid |
decimal number |
None. |
| AuthorisationCode |
The authorisation code |
string |
None. |
| PaymentTime |
The time payment was made |
date |
None. |
| PaidUntil |
The time this transaction has been paid until. The customer must leave the carpark before this time to avoid additional charges |
date |
None. |
| PromotionValue |
The amount to be discounted as part of the promotion |
decimal number |
None. |
| PromotionCode |
The promotion identification code |
string |
None. |
| PromotionDescription |
A brief description of why the promotion was applied |
string |
None. |
Response Formats
application/json, text/json
{
"FacilityNo": 1,
"CarparkNo": 2,
"TicketNo": "sample string 3",
"TicketType": 4,
"Amount": 5.1,
"AuthorisationCode": "sample string 6",
"PaymentTime": "2025-08-31T06:25:00.4891136+00:00",
"PaidUntil": "2025-08-31T06:25:00.4891136+00:00",
"PromotionValue": 9.1,
"PromotionCode": "sample string 10",
"PromotionDescription": "sample string 11"
}