Web Service Functions

This article lists all functions that are exposed via Web Service.

Functions That Use XML Encoding of Data Tables

1. getXML

The getXML Web Service function is used to retrieve values of Iotellect Server context variables.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Get variable operation will be executed with this user's permissions.
password	String	Password for the user account.
context	String	Context path for the variable.
variable	String	Name of variable.

Return value: this function returns a String that is a Data Table containing the value of requested variable. This value is encoded in XML format. See Data Table XML Encoding for more information. The resulting XML string is encoded once again according to the URL encoding standard specified by RFC 1738 (Uniform Resource Locators). This is to ensure that the resulting string doesn't contain characters unsafe for SOAP protocol.

2. setXML

The setXML function allows to change the value for a Iotellect Server context variable.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Set variable operation will be executed with the this user's permissions.
password	String	Password for the user account.
context	String	Path of context to set variable in.
variable	String	Name of variable.
value	String	New value of the variable encoded in XML format. See Data Table XML Encoding for more information. The resulting XML document is encoded once again according to URL encoding standard specified by RFC 1738 (Uniform Resource Locators). This is to ensure that the resulting string doesn't contain characters unsafe for SOAP protocol.

Return value: none.

In most cases, the value argument passed to this function is a Data Table that was previously retrieved by the getXML function.

3. callXML

The callXML function is used to execute Iotellect Server context functions, by passing function arguments in an XML-encoded Data Table.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Call function operation will be executed with this user's permissions.
password	String	Password for the user account.
context	String	Path of context from which the function is to be called.
function	String	Name of function.
value	String	Data Table containing function input parameters. This table is encoded in XML format. See Data Table XML Encoding for more information. The resulting XML document is encoded once again according to URL encoding standard specified by RFC 1738 (Uniform Resource Locators). This is to ensure that the resulting string doesn't contain characters unsafe for SOAP protocol.

Return value: this Web Service function returns a String that is a Data Table returned by the function executed. This value is encoded just like the value input parameter above.

Functions That Represent Data Tables as String Arrays

1. setByStringArray

The setByStringArray function is used to change values of Iotellect Server context variables. Cells of the Data Table containing the new value are passed to it as an array of String arguments.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Set variable operation will be executed with this user's permissions.
password	String	Password for the user account.
context	String	Path of context where the variable is located.
variable	String	Name of variable.
values	String[]	An array of Strings, used to fill Data Table with the new variable value as described here.

Return value: none.

2. callByStringArray

The callByStringArray function allows to execute Iotellect Server context function by passing its arguments as a String array.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Call function operation will be executed with this user's permissions.
password	String	Password for the user account.
context	String	Path of context to call function from.
function	String	Name of function.
parameters	String[]	Array of Strings that are used to fill Data Table representing function input value as described here.

Return value: this Web Service function returns a String that is a Data Table returned by the function executed. This value is encoded in XML format. See Data Table XML Encoding for more information. The resulting XML string is encoded once again according to the URL encoding standard specified by RFC 1738 (Uniform Resource Locators). This is to ensure that the resulting string doesn't contain characters unsafe for SOAP protocol.

3. AddRecordByStringSrray

The addRecordByStringSrray function is used to new record(s) to a tabular context variable. Fields of a new Data Table record are passed to it as an array of String arguments.

Technically, the function reads variable value, adds new record to it, and writes new value back to the context.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Get variable/Set variable operations will be executed with this user's permissions.
password	String	Password for the user account.
context	String	Path of context where the variable is located.
variable	String	Name of variable.
values	String[]	An array of Strings, used to fill new Data Table record with the values as described here.

Return value: none.

4. setVariableField

The setVariableField function is used to change a single cell (specified by field name and row number) of context variable. The new cell value is passed as a String argument.

Technically, the function reads variable value, changes a single cell of this value (that is a Data Table), and writes (sets) new value back to the context.

Function parameters:

Name	Type	Description
username	String	Name of Iotellect Server user account that will be used to log in to the server. The Get variable/Set variable operations will be executed with this user's permissions.
password	String	Password for the user account.
context	String	Path of context where the variable is located.
variable	String	Name of variable.
field	String	Name of field.
row	int	Row number.
value	String	New cell value in the String form.

Return value: none.

Functions That Use Native Encoding of Data Tables

There are three Web Service functions that use native Data Table encoding:

get
set
call

These functions are used to get/set values of Iotellect Server context variables and call context functions respectively.

DPF_EXPORT_V5.8.8 / TIME_1743710558 / 2025-04-03 20:02:38 / STRLEN_17331 / STRLEN_HTML_17426

{VERSION}

Was this page helpful?