Adding Additional Services to Service Plan

The add-plan-item operation is used to add custom options of service plans (additional services) to service plans.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet adding a new additional service to a service plan includes the add-plan-item operation node:

<packet>
<service-plan>
   <add-plan-item>
   ...
   </add-plan-item>
</service-plan>
</packet>

 

The add-plan-item node is presented by type ServicePlanPlanItemInputType (domain_template.xsd). Its graphical representation is as follows:

ServicePLanPlanItemInput-add

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

 

Response Packet Structure

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

ServicePLanPlanItemOutput-add

 

Samples

This packet adds an additional service Additional Service to the service plan with id 1234 owned by user with login name JDoe.

<packet>
<service-plan>
   <add-plan-item>
      <filter>
         <id>1234</id>
      </filter>
      <owner-login>JDoe</owner-login>
      <plan-item>
         <name>Additional Service</name>
      </plan-item>
   </add-plan-item>
</service-plan>
</packet>

Response:

<packet>
<service-plan>
   <add-plan-item>
      <result>
         <status>ok</status>
         <id>1234</id>
         <name>Additional Service</name>
         <guid>0ca04c13-55cc-2542-04b4-1f792a217a3e</guid>
         <external-id>456</external-id>
         <item>Additional Service</item>
      </result>
   </add-plan-item>
</service-plan>
</packet>