itgendoc001X
xMsg javascript has not been loaded.
Yuki API Data ModelCatalog: Yuki
Schema: Contact
This is a read-only table function. The Yuki API may not support changing the data or the Invantive SQL driver for Yuki does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Yuki API.
Yuki API URL: https://api.yukiworks.nl/ws/Contact.asmx
Topic: SearchContacts
Base XPath: /soap11:Envelope/soap11:Body/tns:SearchContactsResponse
XPath: /tns:SearchContactsResult/Contacts/Contact
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ContactsByDomainId. 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 |
|---|---|---|---|---|
active |
string |
☐ |
|
Both or Active or Inactive |
domainId |
string |
☑ |
|
|
modifiedAfter |
datetime |
☐ |
|
|
searchOption |
string |
☐ |
|
All or Name or City or Postcode or Tag or Email or Website or Phone or Code or CoCNumber or VATNumber or BankAccount or ID |
searchValue |
string |
☐ |
|
|
Table Function Columns
The columns of the table function ContactsByDomainId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string(36) |
Partition Code |
☐ |
|
COMPANY_NAME |
string(240) |
Partition Name |
☐ |
|
DOMAINID |
string(36) |
|
☐ |
|
DOMAINNAME |
string(240) |
|
☐ |
|
NAME |
string |
Name |
☐ |
|
06-04-2021 14:39 Version 20.1.393-BETA+3152
