Roller API Data Model
BookingItemsByBookingId: Roller Booking Items by ID |
Catalog: Roller
Schema: Data
Label: Booking Items by ID
Documentation:
Booking item details.
This is a read-only table function. The Roller API may not support changing the data or the Invantive SQL driver for Roller does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Roller API.
Select Roller API URL: bookings/{uniqueIdOrBookingId}
Insert Roller API URL: bookings/{uniqueIdOrBookingId}
Update Roller API URL: bookings/{uniqueIdOrBookingId}
Delete Roller API URL: bookings/{uniqueIdOrBookingId}
Field Selection Method: NotRequired
Base Path: items[*]
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function BookingItemsByBookingId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
uniqueIdOrBookingId |
string |
☐ |
|
ID of the booking to get. |
Columns of Table Function
The columns of the table function BookingItemsByBookingId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
booking_comments |
string |
|
☐ |
Additional information about the booking. |
booking_companyId |
string |
|
☐ |
The Id of the company who made the booking. |
booking_createdDate |
datetime |
|
☑ |
Date the booking item was created. |
booking_customerId |
string |
|
☐ |
Unique identifier of the customer linked to the booking. |
booking_discount |
decimal |
|
☐ |
Total discount applied. |
booking_externalId |
string |
|
☐ |
External booking ID. |
booking_fees |
decimal |
|
☐ |
Total fees applied. |
booking_name |
string |
|
☐ |
Name of the booking can be different to the booking owner (defaults to the booking owner's name). |
booking_remainder |
decimal |
|
☐ |
Total remaining cost/outstanding balance. |
booking_source |
string |
|
☐ |
The application that created the booking. |
booking_status |
string |
|
☐ |
Booking status. |
booking_total |
decimal |
|
☐ |
Total cost. |
booking_uniqueID |
guid |
|
☐ |
Unique booking ID. |
bookingDate |
datetime |
Booking Date |
☐ |
The date this item was purchased or the date this item is valid for. |
bookingEndDate |
datetime |
|
☐ |
The date this item is valid until (this can change after first check-in dependend in product configuration). |
bookingItemId |
int32 |
|
☐ |
Unique identifier for an item. |
bookingReference |
string |
Booking Reference |
☑ |
Unique identifier for a booking. |
endTime |
string |
|
☐ |
Session end time in 24hr format e.g. 13:30 = 1:30 PM. |
productId |
int32 |
Product ID |
☐ |
Unique identifier for a product. |
quantity |
int32 |
Quantity |
☐ |
Number of items purchased - same as number of tickets except when GroupSize is greater than one. |
startTime |
string |
|
☐ |
Session start time in 24hr format e.g. 11:30 = 11:30 AM. |
22-09-2022 21:51 Version 22.0.355-PROD+3587
