The sequences shown below outline some of the common use cases for the APT.MobileAPI.
|
Aquire ticket number |
→ |
Scan the QR or ITF barcode on physical ticket and call api/GetTicketFromBarcode |
or |
Call api/GetTicketFromPartial with the last 6 digits of the physical ticket |
or |
Call api/GetTicketFromPlate with the vehicles registration plate |
|
↓ |
||||||
|
Request the outstanding amount/parking session details |
→ |
Call api/CalculateRate with the ticket details gathered in step 1 |
||||
|
↓ |
||||||
|
Process the payment with external PSP |
||||||
|
↓ |
||||||
|
If successful then apply the payment to the ticket |
→ |
Call api/ApplyPayment with the applicable payment information |
|
Aquire ticket number |
→ |
Scan QR code on physical ticket |
or |
Call api/GetTicketFromPartial with the last 6 digits of the physical ticket |
or |
Call api/GetTicketFromPlate with the vehicles registration plate |
|
↓ |
||||||
|
Request the outstanding amount/parking session details |
→ |
Call api/CalculateRate with the ticket details gathered in step 1 |
||||
|
↓ |
||||||
|
Verify parking session meets the criteria of the promotion |
||||||
|
↓ |
||||||
|
Aquire validation provider number |
→ |
Use a pre-agreed validation provider number supplied by the parking system operator for this specific promotion |
or |
Call api/GetValidationProviders to retrieve a list of all available validation providers |
||
|
↓ |
||||||
|
Apply the validation to the ticket |
→ |
Call api/ApplyValidation with the applicable provider information |