Updating an Additional Service

The update operation is used to edit a custom option of service plans (additional service).

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet editing an additional service includes the update operation node:

<packet>
<plan-item>
   <update>
   ...
   </update>
</plan-item>
</packet>

 

The update node does not have a separate data type, it is nested within the complex type (plan_item.xsd). The update node has the following graphics representation:

updateInput

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

 

Response Packet Structure

The update node of the output XML packet is structured as follows:

domainGenInfoType

 

Samples

Editing an additional service

This packet edits an additional service plan-item with the following information: the additional service is called New Service, its description is Additional service description, the additional service is available for adding to subscriptions, the URL attached to a custom button created for this additional service is http://domain.com, site ID and name, FTP user name and password is included into HTTP request when a customer clicks the custom button, the filename.png file is used as a background image for the custom button.

<packet>
<plan-item>
   <update>
      <filter>
        <name>plan-item</name>
      </filter>
      <visible>true</visible>
      <label>New Service</label>
      <tooltip>Additional service description.</tooltip>
      <url>http://domain.com</url>
      <internal>true</internal>
      <url-components>
         <dom-id>true</dom-id>
         <dom-name>true</dom-name>
         <ftp-user>true</ftp-user>
         <ftp-pass>true</ftp-pass>
         <cl-id>false</cl-id>
         <cname>false</cname>
         <pname>false</pname>
         <email>false</email>
      </url-components>
      <image-file>filename.png</image-file>
   </update>
</plan-item>
</packet>

Response:

<packet>
<plan-item>
   <update>
      <result>
         <status>ok</status>
         <name>plan-item</name>
      </result>
   </update>
</plan-item>
</packet>