Skip to main content
Omnitracs Knowledge Base

Get Role Details


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.




      <roleName>CER Admin</roleName>




Sample XML Response



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


            <name>CER Admin</name>

            <description>CER Administrator</description>




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







                  <description>Can maintain company settings</description>












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

  • Was this article helpful?