Use the get operation to retrieve settings of web users on a specified site. A web user settings have less priority than web user preferences. If you cannot update web user settings - check web users preferences of the site. For more information on the preferences, refer to the Retrieving Web Users Preferences section.
A request XML packet retrieving settings of web users includes the get operation node:
<packet version="1.4.2.0">
<webuser >
<get>
...
</get>
</webuser>
</packet>
The get node is presented by type WebUserSetInputType (webuser.xsd
), and its graphical representation is as follows:
webuser.xsd
).Remarks
You can retrieve settings of multiple web users using different filtering rules in a single packet. Add as many get operations as the number of different filtering rules to be used.
<packet version="1.4.2.0">
<get>
...
</get>
...
<get>
...
</get>
</packet>
The get node of the output XML packet is presented by type WebUserGetOutputType (webuser.xsd
) and structured as follows:
common.xsd
).The following nodes are required only if the get operation succeeds:
Note: If a value for a node is "false", it is not nested in the packet.
The following request retrieves settings of the web user with login name abcdef.
<packet>
<webuser>
<get>
<filter>
<login>abcdef</login>
</filter>
</get>
</webuser>
</packet>
Response:
<packet>
<webuser>
<get>
<result>
<status>ok</status>
<filter-id>abcdef</filter-id>
<id>17</id>
<login>abcdef</login>
<ftp-quota>-1</ftp-quota>
</result>
</get>
</webuser>
</packet>
The following request retrieves settings of all web users from example.com, and example2.com sites.
<packet>
<webuser>
<get>
<filter>
<site-name>example.com</site-name>
<site-name>example2.com</site-name>
</filter>
</get>
</webuser>
</packet>
Response:
<packet>
<webuser>
<get>
<result>
<status>ok</status>
<filter-id>example.com</filter-id>
<id>17</id>
<login>FirstUser</login>
<ftp-quota>-1</ftp-quota>
<php>true</php>
<cgi>true</cgi>
</result>
<result>
<status>ok</status>
<filter-id>example.com</filter-id>
<id>18</id>
<login>SecondUser</login>
<ftp-quota>100</ftp-quota>
<php>true</php>
</result>
<result>
<status>ok</status>
<filter-id>example2.com</filter-id>
<id>11</id>
<login>FirstUser</login>
<ftp-quota>100</ftp-quota>
<php>true</php>
</result>
</get>
</webuser>
</packet>