| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | |
Input parameters:
- [login] : string : name of FTP account
- homePath : string : FTP account home path (relative to the domain)
- passwFTP : string : FTP account password
- quota : int : account quota in MB or -1 if unlimited.
- type : string : type of FTP account (R -> read only / RW -> read and write)
Output parameters:
- Return a boolean with true value if the operation has been executed correctly
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_EXCEDED_LIMIT_RESOURCES
- ERROR_FTP_QUOTAEXECED
- ERROR_FTP_ADDUSER
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: client, domain
Necessary permissions: PERM_DOMAIN_FTP
Remarks:
- Create a new FTP account.
- If the login is null, an auto-generated sequential name will be assigned to the account.
Examples:
.NET Java PHP
Input parameters:
- ftpID : int : FTP account ID
Output parameters:
- Return a boolean with true value if the operation has been executed correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_FTP_USERNOTEXISTS
- ERROR_FTP_DELUSER
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_FTP
Remarks:
- Eliminate the FTP account ftpID.
Examples:
.NET Java PHP
Input parameters:
- ftpID : int : FTP account ID
- newPassword : string : new password
Output parameters:
- Return a boolean with true value if the operation has been executed correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_FTP_USERNOTEXISTS
- ERROR_FTP_CHANGEPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_FTP
Remarks:
- Assign the new password newPassword to the FTP account ftpId.
Examples:
.NET Java PHP
Input parameters:
- ftpID : int : FTP account ID
- quota : int : new quota (in MB and -1 if unlimited)
Output parameters:
- Return a boolean with true value if the operation has been executed correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_FTP_USERNOTEXISTS
- ERROR_FTP_CHANGEQUOTA
- ERROR_FTP_QUOTAEXECED
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_FTP
Remarks:
- Update the quota assigned to account ftpID.
Examples:
.NET Java PHP
Input parameters:
- [searchLogin] : string : search filter by FTP account name
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfFTPUserInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_FTP_LISTUSERS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- Return the FTP users list for the domain using the WebService.
- The order parameters can be the following:
- login : FTP account name
- quota : FTP account assigned quota
- date : FTP account creation date
- type : type of account FTP (R / RW / P)
Examples:
.NET Java PHP
Input parameters:
- $userID : int : FTP account ID
Output parameters:
- Returns a FTPUserInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_FTP_GETUSERINFO
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_FTP
Remarks:
- Obtain information on FTP account associated to userID.
Examples:
.NET Java PHP
Input parameters: none
Output parameters:
- Returns a LoginInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_FTP_GETPRINCIPALLOGIN
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: none
Remarks:
- Obtain information on the domain's principal FTP account
Examples:
.NET Java PHP