Response Packet Structure

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

• The result node is required. It wraps the response received from the server. Data type: FtpUserGetResultType (ftpuser.xsd).
• The status node is required. It specifies the execution status of the get operation. Data type: result_status. Allowed values: ok | error.
• The errcode node is optional. It is used to return the error code when the get operation fails. Data type: unsignedInt.
• The errtext node is optional. It is used to return the error message if the get operation fails. Data type: string.
• The filter-id node is optional. It is required if the get operation succeeds. It returns the filtering rule. For more information, refer to the Filtering Issues section. Data type: anySimple.
• The id node is optional. It is required if the get operation succeeds. It returns the unique identifier of the FTP account which settings are retrieved in the response packet. Data type: integer.
• The name node is optional. It is required if the get operation succeeds. It specifies the name under which the FTP account is known in Plesk, and the account login. Data type: string.
• The home node is optional. It is required if the get operation succeeds. It specifies the home directory of the FTP account, i.e., the directory access to which is granted for the account user. Data type: string.
• The quota node is optional. It is required if the get operation succeeds. It specifies the maximum total size of files and folders (in bytes) that the FTP account user can create in or upload to the home directory. Data type: integer.
• The permissions node is optional. It is required if the get operation succeeds. It specifies the FTP account permissions for home directory. For more information, refer to section FTP Account Permissions. Data type: FtpUserPermissions.
• The domain-id node is optional. It is required if the get operation succeeds. It specifies the ID of the domain on which the FTP account exists. Data type: integer.

Remarks

In case when a domain was specified as filtering rule in a request packet, and there are no FTP accounts existing on that domain, response packet does not contain the name, home, quota, permissions and domain-id nodes.