Delete Role

Last updated
Save as PDF

deleteRole

Given a role name and an optional company ID, this web service deletes a user role on the Services Portal.

void deleteRole(string companyId, string roleName) 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 name of the role to be deleted.

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.

<soap:Body>

<deleteRole>

<companyId>MYCOMPANY</companyId>

<roleName>MyRole</roleName>

</deleteRole>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p431:deleteRoleResponse xmlns:p431="http://websvcs.omaswebws"/>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Invalid role name.
007 Cannot delete role.