Get User Capability - OMCAPVAL
Get User Capability (OMCAPVAL)
Required Parameter Group:
1 |
User Capability Bytes |
Input |
Char(4) |
2 |
Capability Mnemonic |
Input |
Char(8) |
3 |
Authorization Flag |
Output |
Char(1) |
API Overview:
The Get User Capability API (OMCAPVAL) returns a logical yes/no value specifying whether a QTRACS user has been granted a given capability. These capabilities are represented as a series of bits within the QTRACS User Database. These bits are cumbersome to query manually, therefore, this routine will provide a simple interface to all calling applications that determines if a user is authorized to a particular function.
Required Parameter Group Details:
(1) User Capability Bytes
INPUT; CHAR(4)
This parameter accepts four single-character fields that define a given user's capabilities. These four fields are found in the QTRACS User Database. They should be retrieved via the OMVENT API and passed to this program for interpretation.
(2) Capability Mnemonic
INPUT; CHAR(8)
This parameter must be one of the following predefined mnemonics. It instructs the API to inspect the corresponding capability bit and return a logical flag.
C%REDIRE |
Redirect Other's Message Notification |
C%WWVEHL |
Work with Vehicles |
C%WWCVRG |
Work with Coverages |
C%WWUSER |
Work with Users |
C%WWMACR |
Work with Macros |
C%WWAPPL |
Work with Applications |
C%MEMERG |
Send Emergency Forward Messages |
C%MATNTN |
Send Attention Forward Messages |
C%RESYNC |
Resynchronize Macros |
C%WWDRVR |
Work with Drivers |
C%WWSUTL |
Work with System Utilities |
C%ADDLOC |
Add or Change a QTRACS Place |
C%WWCAPS |
Change User Capabilities |
C%M2ALLV |
Send Messages to All Vehicles |
C%WWBINM |
Work with Binary Message Routing |
C%WWQCFG |
Work with QTRACS Configuration |
C%STVEHL |
SensorTRACS Vehicle Administration |
C%STDRVR |
SensorTRACS Driver Administration |
C%STCYCL |
SensorTRACS Extract Cycle Administration |
C%STVPRM |
SensorTRACS Vehicle Parameter Administration |
C%STRGEN |
SensorTRACS Report Generator Administration |
C%JTADIM |
JTRACS Administrative Level |
C%XMITMS |
Send Forward Macro Messages to Mobile Units |
C%MUNFLT |
Send Forward Messages to Ungrouped Fleets |
C%MTONMC |
Send Forward Messages to NMC |
C%MCLAIM |
Claim Other's Messages |
C%MDELET |
Delete Other's Messages |
C%DLTUNS |
Delete Your Own Unseen Messages |
C%WWPHBK |
Work with Vehicle Phone Book |
C%WWFLBK |
Work with Vehicle Fleet Book |
C%XMITFF |
Send Forward FreeForm Messages to Mobile Units |
(3) Authorization Flag
OUTPUT; CHAR(1)
Logical value that indicates if the user is authorized to the requested function. Valid values are:
0 |
Not Authorized |
1 |
Authorized |