Book Contents

Previous Topic

Next Topic
Response Packet Structure

The set node of the output XML packet is structured as follows:
  • The result node is required. Can be present in the response packet many times (by the number of templates specified in the request packet). It wraps the result of the set operation for a single domain template. Data type: resultType (common.xsd).

 
  • The status node is required. Specifies the execution status of the set operation. Data type: result_status (string). Allowed values: ok | error.
  • The errcode node is optional. Is required if the set operation fails. Returns the error code. Data type: unsignedInt.
  • The errtext node is optional. Can be returned if the set operation fails. Returns the error message. Data type: string.
  • The id node is optional. If the 'request' packet fails before the execution, this node is missing in the 'response' packet. See topic Handling error codes for details. In all other cases it holds the identifier of the domain template (if this id was specified in the 'request' packet). Data type: integer.
  • The name node is optional. If the 'request' packet fails before the execution, this node is missing in the 'response' packet. See topic Handling error codes for details. In all other cases it holds the name of the domain template (if this name was specified in the 'request' packet). Data type: string.