Get User Capabilities

Last updated
Save as PDF

getUserCapabilities

The getUserCapabilities() web service returns an array of Capability objects for a user.
This array can optionally be filtered to return information for a single application using the application ID input parameter.

Capability[] getUserCapabilities(string companyId, string userId, string applicationId) 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.
userId: (optional) A string of maximum length 10 that specifies the unique user identifier. If no user is specified, the authorized user will be used.

applicationId: (optional) A string of maximum length 10 that specifies the unique application identifier for which capabilities should be returned. Valid values are:

Value	Description	Returned Value
blank/nil	Request capabilities for all applications the user is authorized to use.	Returns an array of Capability objects containing all of the user's application capabilities.
appId	Request the user's capabilities for the specified application.	Returns an array of Capability objects containing all of the user's application capabilities for the specified application.

Value

Description

Returned Value

blank/nil

Request capabilities for all applications the user is authorized to use.

Returns an array of Capability objects containing all of the user's application capabilities.

appId

Request the user's capabilities for the specified application.

Returns an array of Capability objects containing all of the user's application capabilities for the specified application.

Returns a null string on exceptions; otherwise returns an array of Capability objects.

A full list of application IDs and app-specific capabilities can be found on the Application Information and Capability Information pages.

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
- Admin role

Customer integrators are authorized to their own company's data only.

Sample XML Requests and Responses

Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getUserCapabilities>

<companyId>ACME</companyId>

<userId>JSMITH</userId>

<applicationId/>

</getUserCapabilities>

</soap:Body>

Response

<soapenv:Body>

<getUserCapabilitiesResponse>

<getUserCapabilitiesReturn>

<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>QTRACS</applicationId>

<description>Can use QTRACS</description>

<group>QTGENERAL</group>

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

<position>1</position>

</Capability>

<Capability>

<applicationId>QTRACS</applicationId>

<description>Can ping vehicle</description>

<group>QTADMIN</group>

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

<position>0</position>

</Capability>

</capabilities>

</getUserCapabilitiesReturn>

</getUserCapabilitiesResponse>

</soapenv:Body>

Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getUserCapabilities>

<applicationId>QTRACS</applicationId>

<companyId>ACME</companyId>

<userId>JSMITH</userId>

</getUserCapabilities>

</soap:Body>

Response

<soapenv:Body>

<getUserCapabilitiesResponse>

<getUserCapabilitiesReturn>

<capabilities>

<Capability>

<applicationId>QTRACS</applicationId>

<description>Can use QTRACS</description>

<group>QTGENERAL</group>

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

<position>1</position>

</Capability>

<Capability>

<applicationId>QTRACS</applicationId>

<description>Can ping vehicle</description>

<group>QTADMIN</group>

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

<position>0</position>

</Capability>

</capabilities>

</getUserCapabilitiesReturn>

</getUserCapabilitiesResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Invalid user id.
007 Invalid application id.
008 No capabilities found.