Response Packet Structure

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

• The result node is required. It wraps the response retrieved from the server. Data type: ResellerTemplateOutputResulttype (reseller_template.xsd).
  • The status node is required. It specifies the execution status of the get operation. Data type: result_status (common.xsd). Allowed values: ok|error.
  • The errcode node is required if the get operation fails. It returns the error code. Data type: unsignedInt.
  • The errtext node is required if the get operation fails. It returns the error message. Data type: string.
  • The id node is required if the get operation succeeds, or if the results are filtered by ID. It returns ID of the reseller template which settings are retrieved in the result node. Data type: integer.
  • The name node is required if the get operation succeeds, or if the results are filtered by name. It returns the name of the reseller template which settings are retrieved in the result node. Data type: string.
  • The limits node is required if the request get packet specifies the limits node and the operation succeeds. Data type: resellerLimits (reseller.xsd). To view the structure of this node, refer to the Limits section.
  • The permissions node is required if the request get packet specifies the permissions node and the operation succeeds. Data type: clientPerms (plesk_client.xsd). To view the structure of this node, refer to the Permissions section.
  • The ip-pool node is required if the request get packet specifies the ip-pool node and the operation succeeds. Data type: ResellerTemplateIpPoolType (reseller_template.xsd). To view the structure of this node, refer to the IP Pool Settings section.
  • The preferences node is required if the request get packet specifies the preferences node and the operation succeeds. Data type: ResellerTemplatePreferencesType (reseller_template.xsd). To view the structure of this node, refer to the Preferences section.