Retrieving Protected Directory User Settings
Use the get-user operation to retrieve protected directory user settings.
Request Packet Structure
A request XML packet retrieving protected directory user settings includes the get-user operation node:
The get-user node is presented by type ProtectedDirGetUserInput (
protected_dir.xsd), and its graphical representation is as follows:
- The filter node is required. It specifies the filtering rule. For details, refer to the Available Filters section. Data type: ProtectedDirUserFilter (
Response Packet Structure
The delete-user node of the output XML packet is presented by type ProtectedDirGetUserOutput (
protected_dir.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 operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. Is returns the error code if the operation fails. Data type: integer.
- The errtext node is optional. It returns the error message if the operation fails. Data type: string.
- The filter-id node is required if the request packet is valid. It returns the filtering rule parameter. For details, refer to the Available Filters section. Data type: anySimple.
- The id node is required if the operation succeeds. It returns the ID of the protected directory user. Data type: integer.
- The data node is required if the operation succeeds. It contains protected user settings. Data type: complex.
- The login node is required if the operation succeeds. It contains the protected user login. Data type: string.
Retrieving settings of a single protected directory user
The packet that retrieves settings of the protected directory user with ID 1 looks as follows:
If the user was not found, the response from the server looks as follows:
Retrieving settings of multiple protected directory users
The packet that retrieves settings of all users of the protected directory with ID 1 looks as follows: