Supporting API Functions
In this article
Syncing Allowances to the front end: UploadPurchasedAllowances()
Syncing the Client bookings to the front-end: UploadClientBookings()
Syncing Allowances to the front end: UploadPurchasedAllowances()
UploadPurchasedAllowances(ClientNo : Code[20];VAR
ActivityIssuedAllowance : XMLport "Activity Issued Allowance")
This function returns currently active allowances for the selected client. This is only for viewing purposes on the front end and is not needed for any functionality. The booking process will automatically detect allowances and consumption in the confirmation process in the Bookings back end.
XML response
Node Name | Prefix | Node Type | Source Type | Data Source |
---|---|---|---|---|
IssuedAllowance | Element | Table | <Activity Issued Allowance> | (Activity Issued Allowance) |
AllowanceNo | Element | Field | Activity Issued Allowance: | :Allowance No. |
ProductNo | Element | Field | Activity Issued Allowance: | :Product No. |
ValidLocation | Element | Field | Activity Issued Allowance: | :Location |
Description | Element | Field | Activity Issued Allowance: | :Description |
QtyIssued | Element | Field | Activity Issued Allowance: | :Quantity Issued |
DateIssued | Element | Field | Activity Issued Allowance: | :Date Issued |
UnitPrice | Element | Field | Activity Issued Allowance: | :Unit Price |
ClientNo | Element | Field | Activity Issued Allowance: | :Client No. |
ClientName | Element | Field | Activity Issued Allowance: | :Client Name |
ExpiryDate | Element | Field | Activity Issued Allowance: | :Expiry Date |
QuantityConsumed | Element | Field | Activity Issued Allowance: | :Quantity Consumed |
IssuedTotalAmount | Element | Field | Activity Issued Allowance: | :Total Amount |
Syncing the Client bookings to the front-end: UploadClientBookings()
UploadClientBookings(ClientNo : Code[
20
];
VAR
ActivityReservations :
XMLport "Activity Reservations")
This function will return a list of the client's current future bookings. This listing could be used on the front end to allow the selection of booking to be canceled, but otherwise only for displaying purposes on the front end.
XML response
Node Name | Prefix | Node Type | Source Type | Data Source |
---|---|---|---|---|
Activities | Element | Table | <Activity Reservation> | (Activity Reservation) |
ActivityNo | Element | Field | Activity Reservation: | :Activity No. |
ProductNo | Element | Field | Activity Reservation: | :Product No. |
Description | Element | Field | Activity Reservation: | :Description |
DateFrom | Element | Field | Activity Reservation: | :Date From |
DateTo | Element | Field | Activity Reservation: | :Date To |
TimeFrom | Element | Field | Activity Reservation: | :Time (From) |
TimeTo | Element | Field | Activity Reservation: | :Time (To) |
Quantity | Element | Field | Activity Reservation: | :Quantity |
UnitPrice | Element | Field | Activity Reservation: | :Unit Price |
LineDiscountPercentage | Element | Field | Activity Reservation: | :Discount % |
TotalAmount | Element | Field | Activity Reservation: | :Amount |
Status | Element | Field | Activity Reservation: | :Status |
PaymentStatus | Element | Field | Activity Reservation: | :Payment Status |
Location | Element | Field | Activity Reservation: | :Location |
ClientNo | Element | Field | Activity Reservation: | :Client No. |
ClientName | Element | Field | Activity Reservation: | :Client Name |
NoOfPersons | Element | Field | Activity Reservation: | :No. of Persons |
LineDiscountAmount | Element | Field | Activity Reservation: | :Discount Amount |
Comment | Element | Field | Activity Reservation: | :Comment |
AllowanceNo | Element | Field | Activity Reservation: | :Allowance No. |