Roller API Data Model
CustomerById: Roller Customer by ID |
Catalog: Roller
Schema: Data
Label: Customer by ID
Documentation:
Customer 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: customers/{customerId}
Insert Roller API URL: customers/{customerId}
Update Roller API URL: customers/{customerId}
Delete Roller API URL: customers/{customerId}
Field Selection Method: NotRequired
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function CustomerById. 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 |
|---|---|---|---|---|
customerId |
string |
☑ |
|
Unique customer ID. |
Columns of Table Function
The columns of the table function CustomerById 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. |
addressCity |
string |
|
☐ |
City of the customer. |
addressCountry |
string |
|
☐ |
Country of the customer. |
addressPostcode |
string |
|
☐ |
Postcode of the customer. |
addressState |
string |
|
☐ |
State of the customer. |
addressStreet |
string |
|
☐ |
Street of the customer. |
addressSuburb |
string |
|
☐ |
Suburb 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. |
lastName |
string |
Last Name |
☐ |
Last name of the customer. |
phone |
string |
|
☐ |
Phone number of the customer. |
22-09-2022 21:51 Version 22.0.355-PROD+3587
