Response Packet Structure

The cform_buttons_list node of the response packet is structured as follows:

• The result node is optional. It wraps the result of the requested cform_buttons_list operation. It can be missing if some error occurs before the validation starts. Data type: resultType (common.xsd).
• The status node is required. It returns the execution status of the cform_buttons_list operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. It is used to return an error code if the cform_buttons_list operation fails. Data type: unsignedInt.
• The errtext node is optional. Can be used to return an error message if the cform_buttons_list operation fails. Data type: string.
• The filter-id node is optional. It is supported by API RPC 1.4.2.0 and later. If supported, it is always present and used to return the parameter by which the domain was filtered by in the request packet. Data type: anySimple.
• The id node is optional. Returns the identifier of the domain whose buttons are requested. It is missing if the request packet fails before the validation on the server side. Data type: integer.
• The button node is optional. It returns a collection of parameters that describe the button (see the details below). It is missing if the request packet fails before the validation on the server side. Data type: buttonDataType (plesk_common.xsd).

Buttons are described by complex type buttonDataType (plesk_common.xsd) as follows:

• The code node is required. It returns the identifier of the button. Data type: string.
• The type node is required. It specifies the button type. Data type: string. Allowed values: link_button (a typical link that references some URL) | comm_button (a typical button whose click event calls a related event handler).
• The name node is required. It contains the localized button name displayed in Plesk Control Panel. Data type: string.
• The name_id node is required. It specifies the localization key associated with the button. Data type: string.
• The group_name node is required. It returns the localized name of the group containing the button. Data type: string.
• The group_name_id node is required. It specifies the localization key of the group name. Data type: string.
• The href node is required. It returns the URL referenced by the button. Data type: string.
• The js_onclick node is optional. It returns the JavaScript code executed at the button click. Data type: text (string, white spaces are allowed).
• The enabled node is required. It indicates whether the button in enabled. If true, the button is active and can be used. Data type: Boolean.
• The new_window node is optional. It indicates whether a new window should be opened in the browser when the button is clicked. Data type: Boolean.
• The tabindex node is optional. It returns the button's tabulation index. Data type: integer. Default value: 0.
• The conhelp_id node is optional. It specifies the localization key of the context help message associated with the button. Data type: string.
• The conhelp node is optional. It returns a context help message displayed in the HELP section of the Plesk navigation pane when pointing at the button with a mouse. Data type: text (string, white spaces are allowed).
• The icon_url node is optional. It specifies the location of the button's icon. Data type: string.