Rename Role
renameRole
Rename a role given the identifier of the existing role and an identifier to which the role will be renamed.
void renameRole(string companyId, string roleName, string newRoleName) throws WSException
- companyId: (optional) A string of maximum length 10 that specifies the unique company identifier. If no company is specified, the company of the authorized user will be used.
- roleName: A string of maximum length 25 containing the current name of the role to be renamed.
- newRoleName: A string of maximum length 25 containing the new name that defines the role.
Authorization Requirements
The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.
Required Application Licenses
- Remote Integration
Required User Permissions
- Can maintain roles
Customer integrators are authorized to their own company's data only.
Sample XML Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample XML Response
|
|
Exceptions
001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Invalid role name.
007 Invalid new role name.