Edit Role

Last updated
Save as PDF

editRole

Given a RoleDetails object and optional company ID, this web service updates a user role on the Services Portal.

void editRole(string companyId, RoleDetails role) 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.
role: A RoleDetails object with the details for updating the role.

Required elements
    - name

Optional elements
    - description
        - To change, set to new description.
        - Blanks indicate the existing description should be cleared.
        - If no change is desired, set to null.
    - capabilities - capability - id - An array containing all capability IDs that should be assigned to the role.
        - All capability IDs assigned to the role will be replaced by those specified in this parameter.
          Note: If either the 'Can use QTRACS' or 'Can use Trailer Tracks' capability is associated with the role, then the 'Can use GeoServices' capability will also be associated with the role.
        - If no change is desired, set to null.

Ignored elements
    - capability - applicationId
    - capability - description
    - capability - group
    - capability - position

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>

<editRole>

<companyId>MYCOMPANY</companyId>

<role>

<name>MyRole</name>

<description>My new role description</description>

<capabilities>

<Capability>

<applicationId/>

<description/>

<group/>

<id>C.QT.0000</id>

<position/>

</Capability>

<Capability>

<applicationId/>

<description/>

<group/>

<id>C.QT.0106</id>

<position/>

</Capability>

<Capability>

<applicationId/>

<description/>

<group/>

<id>C.QT.0121</id>

<position/>

</Capability>

<Capability>

<applicationId/>

<description/>

<group/>

<id>C.QT.0129</id>

<position/>

</Capability>

</capabilities>

</role>

</editRole>

</soap:Body>

Sample XML Response

<soapenv:Body>

<p431:editRoleResponse 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 Invalid role description.
008 Invalid capability id.