Response Samples

Retrieving database parameters

This packet retrieves information on a database with ID 5.

<packet version="1.4.2.0">
<database>
   <get-db>
      <filter>
          <id>5</id>
      </filter>
   </get-db>
</database>
</packet>

 

Positive response from the server looks as follows:

<packet version="1.4.2.0">
<database>
   <get-db>
      <result>
          <status>ok</status>
          <filter-id>5</filter-id>
          <id>5</id>
          
          <name>MyDatabase</name>
          <type>mysql</type>
          <domain-id>77</domain-id>
          <db-server-id>17</db-server-id>
          <default-user-id>10</default-user-id>
      </result>     
   </get-db>
</database>
</packet>

 

Negative response from the server looks as follows:

<packet version="1.4.2.0">
<database>
   <get-db>
      <result>
          <status>error</status>
          <errcode>1013</errcode>
          <errtext>Database does not exist</errtext>
          <filter-id>5</filter-id>
      </result>     
   </get-db>
</database>
</packet>

 

Retrieving parameters of multiple databases

This packet retrieves information on all databases added to the MyDomain.com, My2Domain.com domains and to the domain specified by ID 45.

<packet version="1.4.2.0">
<database>

   <get-db>

      <filter>
          <domain-name>MyDomain.com</domain-name>
          <domain-name>My2Domain.com</domain-name>
      </filter>
   </get-db>

   <get-db>

      <filter>
          <domain-id>45</domain-id>
      </filter>

   </get-db>

</database>
</packet>

 

One database was found on domain MyDomain.com, the domain with ID 45 and domain My2domain.com were not found. The response from the server in this case looks as follows:

<packet version="1.4.2.0">
<database>
   <get-db>

      <result>

          <status>ok</status>
          <filter-id>MyDomain.com</filter-id>
          <id>5</id>
          
          <name>MyDatabase</name>
          <type>mysql</type>
          <domain-id>77</domain-id>
          <db-server-id>17</db-server-id>
          <default-user-id>10</default-user-id>

      </result>     

   </get-db>

   <get-db>

      <result>

          <status>error</status>
          <errcode>1015</errcode>
          <errtext>Domain does not exist</errtext>
          <filter-id>My2Domain.com</filter-id>

      </result>     

      <result>

          <status>error</status>
          <errcode>1015</errcode>
          <errtext>Domain does not exist</errtext>
          <filter-id>45</filter-id>

      </result>     

 
   </get-db>
</database>
</packet>

 

When two or more databases are found on the specified domain, a server response is the following:

<packet version="1.4.2.0">
<database>
   <get-db>

      <result>

          <status>ok</status>
          <filter-id>MyDomain.com</filter-id>
          <id>5</id>
          
          <name>MyDatabase</name>
          <type>mysql</type>
          <domain-id>77</domain-id>
          <db-server-id>17</db-server-id>
          <default-user-id>10</default-user-id>

      </result>     
   </get-db>

   <get-db>
      <result>

          <status>ok</status>
          <filter-id>MyDomain.com</filter-id>
          <id>8</id>
          
          <name>My2base</name>
          <type>mysql</type>
          <domain-id>77</domain-id>
          <db-server-id>17</db-server-id>
          <default-user-id>10</default-user-id>

      </result>     
   </get-db>
</database>
</packet>