Roller API Data Model
CustomersByDate: Roller Customers by Date |
Catalog: Roller
Schema: Data
Primary Keys: CustomerId
Label: Customers 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/customers
Insert Roller API URL: data/customers
Update Roller API URL: data/customers
Delete Roller API URL: data/customers
Field Selection Method: NotRequired
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function CustomersByDate. 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 CustomersByDate are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
acceptMarketing |
boolean |
Accept Marketing |
☑ |
Whether or not the customer has accepted. |
contactNumber |
string |
Contact Number |
☐ |
Contact phone number of the customer. |
country |
string |
Country |
☐ |
Country of address of the customer. |
createdDate |
datetime |
Created |
☑ |
Date the customer record was created. |
customerId |
string |
Customer ID |
☑ |
Unique identifier of the customer. |
dateOfBirth |
datetime |
Date of Birth |
☐ |
Date of birth of the customer. |
string |
☐ |
Email address of the customer. |
||
firstName |
string |
First Name |
☐ |
First name of the customer. |
gender |
string |
Gender |
☐ |
Gender of the customer. |
lastName |
string |
Last Name |
☐ |
Last name of the customer. |
modifiedDate |
datetime |
Modified |
☑ |
Date the customer record was most recently modified. |
postcode |
string |
ZIP Code |
☐ |
Postcode of the customer. |
22-09-2022 21:51 Version 22.0.355-PROD+3587
