Response Packet Structure

The get_events node of the output XML packet is structured as follows:

• The result node is required. It wraps the response retrieved from the server. Data type: resultType (common.xsd).
• The status node is required. It specifies the execution status of the get_events operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is returns the error code if the get_events operation fails. Data type: integer.
• The errtext node is optional. It returns the error message if the get_events operation fails. Data type: string.
• The event node is optional. It contains an action data if the operation succeeds, and the list of retrieved actions is not empty. Data type: complex.

  

  The following nodes are required only if the event node is present in the response packet:

  • The id node is required. It holds action ID. Data type: integer.
  • The type node is required. It specifies the type of the action. Data type: string. Allowed values: created | updated | deleted | status_changed | started | stopped | installed | uninstalled | siteapp_added | siteapp_removed | expired | terminated | exceeded | guid_changed.

Note: The guid_changed type is available in API RPC 1.5.2.0 and later versions.

• The time node is required. It specifies time when the action happened (in Unix timestamp). Data type: unsignedint.
• The class node is required. It specifies the class of object that performed the action. Data type: string. Allowed values: license | service | ip_address | admin_info | siteapp | client | client_limits | client_status | client_prefs | client_perms | client_ip_pool | db | db-user| domain | domain_limits | domain_user| domain_status | phosting | fhosting | subdomain | mailname | webuser | maillist | dns_zone | mailname_antivirus | mailname_spamfilter | mailname_mailgroup | mailname_autoresponder | mailname_attachment | session_preferences | db_server | domain_alias | remote_dns | dashboard_preset | dashboard_preset_type | dashboard_preset_name | domain_limit_size | client_limit_size | client_limit_traffic | domain_limit_traffic | plesk_component reseller | reseller_limits | reseller_status | reseller_prefs | reseller_perms | reseller_ip_pool | reseller_limit_size | reseller_limit_traffic

Note: The plesk_component class is available in API RPC 1.5.1.0 and later versions. Classes db and db-user are available in API RPC 1.5.2.0 and later versions. Classes reseller_* are available since API RPC 1.6.0.0.

• The obj_id node is required. It specifies the unique field of an object that performed the action. Data type: string.
• The user node is required. It specifies the login name of a user who performed the action. Data type: string.

• The host node is required. It specifies the IP address of a host from which the action was performed. Data type: string