Retrieving Information of an Additional Service
The get operation is used to retrieve information of a custom option of service plans (additional service).
Request Packet Structure
A request XML packet retrieving information about additional services includes the get operation node:
<packet version="1.6.3.1">
<plan-item>
<get>
...
</get>
</plan-item>
</packet>
The get node does not have a separate data type, it is nested within the complex type (plan_item.xsd
). The get node has the following graphics representation:
- The filter node is required. It specifies the criteria by which the necessary additional service will be selected from the database. Data type: PlanItemFilterType (
plan_item.xsd
). To see the structure of this node, proceed to topic Available Filters.
Response Packet Structure
The get node of the output XML packet is structured as follows:
- The result node is required. It wraps the information about the operation execution and the list of webmail services. Data type: PlanItemResultType (
common.xsd
). - The status node is required. It specifies the execution status of the operation. Data type: result_status (string). Allowed values: ok | error.
- The errcode node is optional. It returns the error code. Data type: unsignedInt.
- The errtext node is optional. It returns the error message. Data type: string.
- The name node is required. It specifies the additional service name. Data type: string.
- The uuid node is required. It specifies the additional service UUID. Data type: string.
- The class node is required. It specifies the class name which implements additional service functionality. Data type: string.
- The visible node is required. It specifies whether the additional service is available for adding to subscriptions. Data type: boolean.
- The applicable-to node is optional. It specifies the type of events the additional service is subscribed to.
- The subscription node is required. It specifies whether the additional service is subscribed to subscription events. Data type: boolean.
- The site node is required. It specifies whether the additional service is subscribed to site events. Data type: boolean.
- The email node is required. It specifies whether the additional service is subscribed to email events. Data type: boolean.
- The label node is required. It specifies the additional service name. Data type: text.
- The tooltip node is required. It specifies additional service description. Data type: text.
- The url node is optional. It specifies the URL attached to the custom button created for the additional service. Data type: urlType.
- The internal node is optional. It specifies whether a custom button is created for the additional service. Data type: boolean.
- The url-components node is optional. It specifies what information is included into HTTP request when a customer clicks a custom button for the additional service. Data type: PlanItemUrlComponentsType (
plan_item.xsd
). To see the structure of this node, proceed to topic url-components. - The image-http-path node is optional. It specifies the path to background image for the custom button. Data type: string.
Samples
This packet retrieves information of an additional service plan-item.
<packet>
<plan-item>
<get>
<filter>
<name>plan-item</name>
</filter>
</get>
</plan-item>
</packet>
Response:
<packet>
<plan-item>
<get>
<result>
<status>ok</status>
<name>plan-item</name>
<uuid>5f3ddf7f-5cca-02ab-7a61-fd8eb662a9eb</uuid>
<class>Plan_Item_Custom</class>
<visible>true</visible>
<applicable-to>
<subscription>true</subscription>
<site>true</site>
<email>true</email>
</applicable-to>
<label>Additional 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-http-path>filename.png</image-http-path>
</result>
</get>
</plan-item>
</packet>