Getting Information on Add-on Plans

The get operation is used to retrieve the information about the add-on 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 that requests information about the specified add-on plans includes the get operation node:

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

The get node is presented by type DomainAddonTemplateGetInputType (domain_addon_template.xsd). Its graphical representation is as follows:

service-plan-addon-get-rps.gif

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 DomainAddonTemplateGetOutputType (domain_addon_template.xsd) which has the following presentation:

service-plan-addon-get-reps.gif

 

Samples

Getting add-on plans that belong to reseller

To get the information about an add-on plan that belongs to a reseller, specify their ID or login.

<packet>
<service-plan-addon>
<get>
   <filter>
      <name>base_plan</name>
   </filter>
   <owner-id>1</owner-id>
</get>
</service-plan-addon>
</packet>

 Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <get>
      <result>
        <status>ok</status>
        <id>11</id>
        <name>base_plan</name>
        <guid>befbe7ca-1c78-cfbb-2eaf-debf4cce4896</guid>
        <external-id/>
        <owner-login>admin</owner-login>
        <limits>
          <limit>
            <name>max_site</name>
            <value>0</value>
          </limit>
          ...
        </limits>
        <hosting>
          <vrt_hst>
            <property>
              <name>ssl</name>
              <value>true</value>
            </property>
            <property>
              ...
          </vrt_hst>
        </hosting>
        <performance>
          <bandwidth>-1</bandwidth>
          <max_connections>-1</max_connections>
        </performance>
        <packages/>
        <permissions>
          <permission>
            <name>manage_phosting_ssi</name>
            <value>true</value>
          </permission>
          ...
        </permissions>
        <php-settings>
          <setting>
            <name>safe_mode</name>
            <value>off</value>
          </setting>
          ...
        </php-settings>
      </result>
    </get>
  </service-plan-addon>
</packet>
Getting add-on plans that belong to the Administrator

Omit the reseller identifiers to get information on behalf of the Administrator:

<packet>
<service-plan-addon>
<get>
   <filter>
      <name>base_plan</name>
   </filter>
</get>
</service-plan-addon>
</packet>

 Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <get>
      <result>
        <status>ok</status>
        <id>11</id>
        <name>base_plan</name>
        <guid>befbe7ca-1c78-cfbb-2eaf-debf4cce4896</guid>
        <external-id/>
        <owner-login>admin</owner-login>
        <limits>
          <limit>
            <name>max_site</name>
            <value>0</value>
          </limit>
          ...
        </limits>
        <hosting>
          <vrt_hst>
            <property>
              <name>ssl</name>
              <value>true</value>
            </property>
            <property>
              ...
          </vrt_hst>
        </hosting>
        <performance>
          <bandwidth>-1</bandwidth>
          <max_connections>-1</max_connections>
        </performance>
        <packages/>
        <permissions>
          <permission>
            <name>manage_phosting_ssi</name>
            <value>true</value>
          </permission>
          ...
        </permissions>
        <php-settings>
          <setting>
            <name>safe_mode</name>
            <value>off</value>
          </setting>
          ...
        </php-settings>
      </result>
    </get>
  </service-plan-addon>
</packet>
Operating multiple add-on plans

A single filter can specify multiple plan instances, all specified either by ID or by the plan name.

<packet>
<service-plan-addon>
<get>
   <filter>
      <name>first_plan</name>
      <name>second_plan</name>
   </filter>
</get>
</service-plan-addon>
</packet> 

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <get>
      <result>
        <status>ok</status>
        <id>13</id>
        <name>first_plan</name>
        <guid>a2c68e48-982a-1807-c2fb-3708bca41836</guid>
        <external-id/>
        <owner-login>admin</owner-login>
...
</result>
      <result>
        <status>ok</status>
        <id>14</id>
        <name>second_plan</name>
        <guid>ccede5cd-3ca3-1db9-f46d-aca67beea2b5</guid>
        <external-id/>
        <owner-login>admin</owner-login>
...
 </result>
    </get>
  </service-plan-addon>
</packet>
Getting information about all add-on plans that belong to a reseller

The following packet gets the information about all add-on plans that belong to reseller technolux:

<packet>
<service-plan-addon>
<get>
   <filter/>
   <owner-login>tecnhnolux</owner-login>
</get>
</service-plan-addon>
</packet>

Response:

 <?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <get>
      <result>
        <status>ok</status>
        <id>9</id>
        <name>Presence Builder</name>
        <guid>4098eff5-418f-c6b5-eaae-e2ffa15b8024</guid>
        <external-id/>
        <owner-id>2</owner-id>
...

</result>
    </get>
  </service-plan-addon>
</packet>
Getting information about all add-on plans that belong to a requester

The following packet gets the information about all add-on plans that belongs to a requester:

<packet>
<service-plan-addon>
<get>
   <filter/>
</get>
</service-plan-addon>
</packet>

 Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
<service-plan-addon>
<get>
<result>
<status>ok</status>
<id>10</id>
<name>base_plan</name>
<guid>7f595c10-9759-48d5-8b83-69080acc7b74</guid>
<external-id/>
<owner-login>admin</owner-login>
...

</result>
    </get>
  </service-plan-addon>
</packet>