Use the get-user operation to retrieve protected directory user settings.
A request XML packet retrieving protected directory user settings includes the get-user operation node:
<packet version="1.5.2.0">
<protected-dir>
<get-user>
...
</get-user>
</protected-dir>
</packet>
The get-user node is presented by type ProtectedDirGetUserInput (protected_dir.xsd
), and its graphical representation is as follows:
protected_dir.xsd
).The delete-user node of the output XML packet is presented by type ProtectedDirGetUserOutput (protected_dir.xsd
) and structured as follows:
common.xsd
).
The packet that retrieves settings of the protected directory user with ID 1 looks as follows:
<packet>
<protected-dir>
<get-user>
<filter>
<id>1</id>
</filter>
</get-user>
</protected-dir>
</packet>
Response:
<packet>
<protected-dir>
<get-user>
<result>
<status>ok</status>
<filter-id>1</filter-id>
<id>1</id>
<data>
<login>user</login>
</data>
</result>
</get-user>
</protected-dir>
</packet>
If the user was not found, the response from the server looks as follows:
<protected-dir>
<get-user>
<result>
<status>error</status>
<errcode>1013</errcode>
<errtext>User is not found</errtext>
<filter-id>1</filter-id>
</result>
</get-user>
</protected-dir>
The packet that retrieves settings of all users of the protected directory with ID 1 looks as follows:
<packet>
<protected-dir>
<get-user>
<filter>
<pd-id>1</pd-id>
</filter>
</get-user>
</protected-dir>
</packet>
Response:
<packet>
<protected-dir>
<get-user>
<result>
<status>ok</status>
<filter-id>1</filter-id>
<id>131</id>
<data>
<login>GuestUser</login>
</data>
</result>
<result>
<status>ok</status>
<filter-id>1</filter-id>
<id>132</id>
<data>
<login>MyUser</login>
</data>
</result>
</get-user>
</protected-dir>
</packet>