Response Samples

Retrieving a web user settings

The following request retrieves settings of the web user with login name abcdef.

<packet version="1.4.2.0">

<webuser>

<get>

   <filter>

      <login>abcdef</login>

   </filter>

</get>

</webuser>

</packet>

A positive response from the server can look as follows:

<packet version="1.4.2.0">

<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>

A negative response from the server can look as follows:

<packet version="1.4.2.0">

<webuser>

<get>

   <result>

      <status>error</status>

      <errcode>1013</errcode>

      <errtext>Web user does not exist</errtext>

      <filter-id>abcdef</filter-id>

   </result>

</get>

</webuser>

Retrieving multiple web users settings

The following request retrieves settings of all web users from example.com, and example2.com domains.

<packet version="1.4.2.0">

<webuser>

<get>

   <filter>

      <domain-name>example.com</domain-name>

      <domain-name>example2.com</domain-name>

   </filter>

</get>

</webuser>

</packet>

Two web users on example.com and one on example2.com match the filtering rule. A positive response from the server can look as follows:

<packet version="1.4.2.0">

<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>

A negative response from the server can look as follows:

<packet version="1.4.2.0">

<webuser>

<get>

   <result>

      <status>error</status>

      <errcode>1015</errcode>

      <errtext>Domain does not exist</errtext>

      <filter-id>example.com</filter-id>

   </result>

   <result>

      <status>error</status>

      <errcode>1015</errcode>

      <errtext>Domain does not exist</errtext>

      <filter-id>example2.com</filter-id>

   </result>

</get>

</webuser>

</packet>