Response Packet Structure

The get-backup-status node of the output XML packet is presented by type BackupGetLocalBackupListOutput (backup.xsd) and 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 operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. Is returns the error code if the operation fails. Data type: integer.
• The errtext node is optional. It returns the error message if the operation fails. Data type: string.
• The backup node is optional. If the operation succeeds, it contains the list of backups stored in the local repository of the specified user. Data type: BackupType (backup.xsd).

  It can be graphically represented in the following way:

  

  • The file node is required. It contains backup details. Data type: BackupFile (backup.xsd).
  • The name node is required. It holds the name of a file included in the backup. Data type: string.
  • The creation-date node is required. It holds the creation date of the file included in the backup. Data type: timestamp.
  • The description node is required. It holds the description of the file included in the backup. Data type: string.
  • The size node is required. It holds the size of the file included in the backup. Data type: size (common.xsd).
  • The not-backup node is optional. It is present in a response packet in case of backup failure. Data type: none.