Response Packet Structure

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

• The result node is required. It wraps the result of the requested get operation. Data type: resultType (common.xsd).
• The status node is required. It returns the execution status of the get operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is used to return the error code when the get operation fails. Data type: unsignedInt.
• The errtext node is optional. Can be used to return an error message if the get operation fails. Data type: string.
• The filter-id node is optional. Returns the name or ID of a customer depending on a way of customer specification in the request packet. Data type: anySimple.
• The id node is optional. It is required if the get operation succeeds. Returns the unique identifier of the customer account whose data is received from Plesk database. Data type: integer.
• The data node is optional. It is present if the get operation succeeds. Returns a requested collection of customer settings. Data type: clientData (plesk_client.xsd). See the structure of this node below.

The data node is defined by complex type clientData (plesk_client.xsd). It is structured as follows:

• The gen_info node is optional. It returns a collection of general customer account settings. Data type: clientGetGenInfo (plesk_client.xsd). See the structure of this node in topic General Customer Account Settings.
• The stat node is optional. It returns a the statistics collected on the specified customer account. Data type: clientStatType (plesk_client.xsd). See the structure of this node in the Statistics topic.

Please send us your feedback on this help page.