Including an App in a Service Plan

The add-package operation is used to include apps to service plans. Once app is included in a service plan, it becomes available for installation to all plan 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>
   <add-package>
   ...
   </add-package>
</service-plan>
</packet>

 

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

ServicePLanApplicationInput-add

a

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

ServicePLanApplicationOutput-add

 

Samples

This packet adds an app WordPress to the service plan base_plan owned by user with login name JDoe.

<packet>
<service-plan>
<add-package>
   <filter>
      <name>base_plan</name>
   </filter>
   <owner-login>JDoe</owner-login>
   <package>
      <name>name</name>
      <value>WordPress</value>
   </package>
</add-package>
</service-plan>
</packet>

Response:

<packet>
<service-plan>
<add-package>
   <result>
      <status>ok</status>
      <filter-id>base_plan</filter-id>
      <id>1234</id>
   </result>
</add-package>
</service-plan>
</packet>