Including an App in an Add-On Plan

The add-package operation is used to include apps to add-on plans. Once app is included in an add-on plan, it becomes available for installation to all add-on subscribers.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet including a new app in a service plan includes the add-package operation node:

<packet>
<service-plan-addon>
   <add-package>
   ...
   </add-package>
</service-plan-addon>
</packet>

 

The add-package node is presented by type ServicePlanAddonApplicationInput (domain_addon_template.xsd). Its graphical representation is as follows:

ServicePLanAddonApplicationInput-add

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

 

Response Packet Structure

The add-package node of the output XML packet is of complex type (domain_addon_template.xsd)which has the following presentation:

ServicePLanApplicationOutput-add

 

Samples

This packet includes an application WordPress in the add-on plan with id 34.

<packet>
<service-plan-addon>
<add-package>
   <filter>
      <id>23</id>
   </filter>
      <package>
      <name>name</name>
      <value>WordPress</value>
   </package>
</add-package>
</service-plan-addon>
</packet>

Response:

<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.7.0">
  <service-plan-addon>
    <add-package>
      <result>
        <status>ok</status>
        <filter-id>23</filter-id>
      </result>
    </add-package>
  </service-plan-addon>
</packet>