Use the set operation to change settings for existing web users on the site.
Request Packet Structure
A request XML packet updating settings of web users includes the set operation node:
The set node is presented by type WebUserSetInputType (
webuser.xsd), and its graphical representation is as follows:
- The filter node is required. It specifies the filtering rule. For more information, refer to the Available Filters section. Data type: WebUserFilter (
- The values node is required. It specifies settings that are updated for web users. For more information, refer to the Web User Settings and Preferences section. Data type: WebUserSetParam (
You can change settings of multiple web users using different filtering rules in a single packet. Add as many set operations as the number of different filtering rules to be used.
Response Packet Structure
The set node of the output XML packet is presented by type WebUserSetOutputType (
webuser.xsd) and structured as follows:
- The result node is required. It wraps the response retrieved from the server. Data type: resultFilterType (
- The status node is required. It specifies the execution status of the set operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. It returns the error code if the set operation fails. Data type: unsignedInt.
- The errtext node is optional. It returns the error message if the set operation fails. Data type: string.
- The filter-id node is required. It returns a filtering rule parameter. For more information, refer to the Available Filters section. Data type: anySimpleType.
- The id node is optional. If the set operation succeeds it holds the ID of the updated web user. Data type: integer.
Updating settings of a single web user
An Agent sends the following request to disable CGI and fastCGI support for the web user identified by login name AbCdEf.
Updating settings of multiple web users
The request packet is as follows:
Response (if three users updated on the site with ID 14, and the site with ID 13 was not found on the server):