Get Role Details

Last updated
Save as PDF

getRoleDetails

Given a role name and optional company Id, this web service returns a RoleDetails object.

RoleDetails getRoleDetails(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.

Returns a null string on exceptions; otherwise returns a RoleDetails object.

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
- None

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>

<getRoleDetails>

<companyId>MYCOMPANY</companyId>

<roleName>CER Admin</roleName>

</getRoleDetails>

</soap:Body>

Sample XML Response

<soapenv:Body>

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

<getRoleDetailsReturn>

<name>CER Admin</name>

<description>CER Administrator</description>

<capabilities>

<Capability>

<applicationId>CER</applicationId>

<description>Can use Critical Event Reporting</description>

<group>CERGENERAL</group>

<id>C.CER.0000</id>

<position>1</position>

</Capability>

<Capability>

<applicationId>CER</applicationId>

<description>Can maintain company settings</description>

<group>CERADMIN</group>

<id>C.CER.0101</id>

<position>2</position>

</Capability>

</capabilities>

</getRolesReturn>

</p431:getRoleDetailsResponse>

</soapenv:Body>

Exceptions

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