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.

Please send us your feedback on this help page.