Roller API Data Model
BookingItems: Roller Booking Items |
Catalog: Roller
Schema: Data
Label: Booking Items
Documentation:
Search bookings by keywords, date and more. At least one search criteria is required. If there are more than 100 bookings only the latest 100 bookings are returned.
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
Insert Roller API URL: bookings
Update Roller API URL: bookings
Delete Roller API URL: bookings
Field Selection Method: NotRequired
Base Path: bookings[*].item[*]
Table Function Parameters
The following parameters can be used to control the behaviour of the table function BookingItems. 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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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 |
|---|---|---|---|---|
Date |
datetime |
☐ |
|
Date of the bookings you are looking for. |
Keywords |
string |
☐ |
|
Keywords match against various properties of a booking including customer detail. Up to 10 bookings are returned. The newest bookings are returned when there are more than 10 matches found. |
LocationIds |
string |
☐ |
|
Comma separated capacity location IDs. Date is required. |
ProductIds |
string |
☐ |
|
Comma separated product IDs. Date is required. |
StartTime |
string |
☐ |
|
Session start time (only applies to session products) e.g. 09:00 = 9am, 13:00 = 1pm. Date is required. |
Table Function Columns
The columns of the table function BookingItems are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
booking_bookingReference |
string |
|
☑ |
Unique identifier for a booking. |
booking_createdDate |
datetime |
|
☑ |
Date the booking item was created. |
booking_customerId |
string |
|
☐ |
Unique identifier of the customer linked to the booking. |
booking_name |
string |
|
☐ |
Name of the booking can be different to the booking owner (defaults to the booking owner's name). |
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. |
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. |
12-12-2020 18:13 Version 20.1.301-BETA+3023
