Roller API Data Model
SignedWaiversByDate: Roller Signed Waivers by Date |
Catalog: Roller
Schema: Data
Primary Keys: SignedWaiverId
Label: Signed Waivers by Date
Documentation:
The timespan covered by the start and end date can not exceed 7 days.
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: data/signedwaivers
Insert Roller API URL: data/signedwaivers
Update Roller API URL: data/signedwaivers
Delete Roller API URL: data/signedwaivers
Field Selection Method: NotRequired
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function SignedWaiversByDate. 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 |
|---|---|---|---|---|
endDate |
datetime |
☑ |
|
Search end date, based on record modified date. |
startDate |
datetime |
☑ |
|
Search start date, based on record modified date. |
Columns of Table Function
The columns of the table function SignedWaiversByDate are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
contactNumber |
string |
Contact Number |
☐ |
Contact phone number of the waiver holder. Not returned for minors. |
createdDate |
datetime |
Created |
☑ |
Date the waiver record was created. |
customerId |
string |
Customer ID |
☐ |
Unique identifier of the customer record of the waiver holder. |
dateOfBirth |
datetime |
Date of Birth |
☐ |
Date of birth of the waiver holder. |
string |
☐ |
Email address of the waiver holder. Not returned for minors. |
||
expiryDate |
datetime |
Expires |
☑ |
Date the waiver expired. |
firstName |
string |
First Name |
☐ |
First name of the customer as completed on the waiver. |
isForMinor |
boolean |
Is for Minor |
☑ |
Identifies whether the customer is a minor or not at the time of signing. Returns true for minors, false for adults. |
isValid |
boolean |
Is Valid |
☐ |
Only returned if waiver verification is required. Returns true for verified waivers and false for unverified. |
lastName |
string |
Last Name |
☐ |
Second name of the customer as completed on the waiver. |
modifiedDate |
datetime |
Modified |
☑ |
Date the waiver record was most recently modified. |
parentSignedWaiverId |
string |
Parent Signed Waiver ID |
☐ |
Only returned for minor's waivers - will be the SignedWaiverId of their parent/guardians waiver. |
signedWaiverId |
string |
Signed Waiver ID |
☑ |
Unique identifier for the waiver record. |
waiverId |
string |
|
☑ |
The identifier of the version of the waiver they have signed. |
22-09-2022 21:51 Version 22.0.355-PROD+3587
