Getting Information on Service Plans

The get operation is used to retrieve the information about service plans. The operation returns all settings in bulk. You cannot request for a definite group of settings. For instance, you cannot retrieve only hosting settings. All settings are optional and can be missing.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet getting information about the specified service plans includes the get operation node:

<packet>
<service-plan>
   <get>
   ...
   </get>
</service-plan>
</packet>

The get node is presented by the type DomainTemplateGetInputType (domain_template.xsd). Its graphical representation is as follows:

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

The get node of the output XML packet is of type DomainTemplateGetOutputType (domain_template.xsd) which is structured as follows:

 

Samples

This request packet requests for the information about a service plan specified by ID.

<packet version="1.6.3.0">
<service-plan>
<get>
   <filter>
      <id>11</id>
   </filter>
</get>
</service-plan>
</packet>

Response:

<packet version="1.6.3.0">
  <service-plan>
    <get>
      <result>
        <status>ok</status>
        <id>11</id>
        <name>base_plan</name>
        <guid>dea4315c-a1da-2ea7-4142-ddc42d0902f9</guid>
        <external-id/>
        <mail>
          <nonexistent-user>
            <reject/>
          </nonexistent-user>
          <webmail>horde</webmail>
        </mail>
        <limits>
          <overuse>notify</overuse>
          <limit>
            <name>max_db</name>
            <value>10</value>
          </limit>
...   
     </limits>
        <log-rotation>
          <off/>
        </log-rotation>
        <preferences>
          <stat>0</stat>
          <maillists>false</maillists>
          <dns_zone_type>master</dns_zone_type>
        </preferences>
        <hosting>
          <vrt_hst>
            <property>
              <name>ssl</name>
              <value>true</value>
            </property>
...
          </vrt_hst>
        </hosting>
        <performance>
          <bandwidth>-1</bandwidth>
          <max_connections>-1</max_connections>
        </performance>
        <permissions>
          <permission>
            <name>create_domains</name>
...

          </permission>
        </permissions>
      </result>
    </get>
  </service-plan>
</packet>