Validate a QTRACS Entity - OMVENT
Validate a QTRACS Entity (OMVENT) RI
Required Parameter Group:
| 1 | Entity Identifier | Input | Char(10) |
| 2 | Format Name | Input | Char(6) |
| 3 | Return Status | Output | Char(1) |
| 4 | Return Block | Output | Char(256) |
API Overview:
The Validate a QTRACS Entity API (OMVENT) is used to verify the existence or absence of a QTRACS entity. Upon successful validation, the API will return a block of requested information to the calling application program. This API provides a reliable and easy to use mechanism for external applications to validate and retrieve information about QTRACS entities.
Required Parameter Group Details:
(1) Entity Identifier
INPUT; CHAR(10)
This parameter contains the QTRACS entity identifier for which to validate and retrieve information.
(2) Format Name
INPUT; CHAR(6)
The format of the information to be returned. Valid values are:
| Blanks | Only entity ID, entity type and entity name are returned |
| VEH100 | Vehicle identification, coverage and group information |
| VEH200 | Vehicle transmission stats and pending request statuses |
| VEH300 | Vehicle's latest position information |
| VEH400 | Vehicle management parameters |
| VEH500 | Vehicle miscellaneous information |
| VEH600 | Vehicle next/last appointment |
| VEH700 | Vehicle global login parameters |
| USR100 | User's message direction, vehicle coverage number and time info |
| USR200 | User capabilities |
| USR300 | User's message handling defaults |
| USR400 | User's directory defaults |
| USR500 | User's message notification defaults |
| USR600 | User statistics |
| USR700 | User proximity query defaults |
| USR800 | User vehicle position history directory controls |
| USR900 | User place directory defaults |
| APP100 | External application queue information and preferences |
| APP200 | External application statistics |
| APP300 | External application position routing |
| LST100 | Address list vehicle coverage information and statistics |
| LST200 | Address list members (first 20) |
| GRP100 | Group information |
| AVH100 | Auxiliary vehicle comm unit number, coverage and group info |
| AVH200 | Auxiliary vehicle transmission stats and pending request statuses |
| AVH300 | Auxiliary vehicle's latest QTRACS position information |
| AVH400 | Auxiliary vehicle management parameters |
| AVH500 | Auxiliary vehicle miscellaneous information |
| AVH600 | Auxiliary vehicle next/last appointment |
| AAC100 | Auxiliary account information |
| AAC200 | Auxiliary account comm unit counts |
| AAC300 | Auxiliary account automated vehicle defaults |
| DRV100 | Driver information |
(3) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, valid entity found and information returned |
| 1 | Failure, entity is not a registered QTRACS entity and no information is returned |
| 2 | Failure, entity block requested does not correspond to the type of entity entered |
| A | Failure, API failed when called remotely |
(4) Return Block
OUTPUT; CHAR(256)
Variable format data structure that returns information to the calling program based on the 'format name' parameter. If the 'return status' parameter is not '0', the contents of this return block are not reliable.
The supported data formats are shown in the shaded tables below.
Blanks Data Format (Only entity ID, entity type and entity name are returned)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
VEH100 Data Format (Vehicle identification, coverage and group information)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Vehicle Comm Unit Number | Char(10) |
| 46-55 | Vehicle Coverage | Char(10) |
| 56-65 | Vehicle Message Group 1 | Char(10) |
| 66-69 | Vehicle Message Group Status | Char(4) |
| 70-84 | Mobile ID Number (Phone No.) ** OBSOLETE ** |
Char(15) |
| 85-85 | Comm Unit Type 0 Unknown 1 MCT 2 TMCT 3 OmniOne 4 MCP Other 5 MCP050 (added v6.2) 6 MCP100 (added v6.2) 7 MCP110 (added v6.2) 8 MCP200 (added v6.2) 9 IVG (added v7.1) |
Char(1) |
| 86-95 | Vehicle Message Group 2 | Char(10) |
| 96-105 | Vehicle Message Group 3 | Char(10) |
| 106-115 | Vehicle Message Group 4 | Char(10) |
| 116-132 | VIN (added v7.2) | Char(17) |
| 133-142 | License Plate Number (added v7.2) | Char(10) |
| 143-148 | Jurisdiction (added v7.2) | Char(6) |
VEH200 Data Format (Vehicle transmission stats and pending request statuses)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-40 | Transmitted Characters | Packed(9,0) |
| 41-45 | Transmitted Messages | Packed(9,0) |
| 46-52 | Time of Last Reset | Packed(13,0) |
| 53-56 | Position Update Request Status | Char(4) |
| 57-60 | Parameter Request Status | Char(4) |
| 61-64 | Global Login Parameter Request Status | Char(4) |
| 65-68 | Unified Address Parameter Request Status | Char(4) |
VEH300 Data Format (Vehicle's latest position information)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-42 | Position Time | Packed(13,0) |
| 43-46 | Latitude (secs) | Packed(7,0) |
| 47-50 | Longitude (secs) | Packed(7,0) |
| 51-51 | Trip Status | Char(1) |
| 52-52 | Vehicle Ignition Status | Char(1) |
| 53-57 | Position Source Type | Char(5) |
| 58-62 | Latitude (decimal degrees) (added v7.0) | Packed(9.6) |
| 63-67 | Longitude (decimal degrees) (added v7.0) | Packed(9.6) |
VEH400 Data Format (Vehicle management parameters)
(Mobile parameter values are documented in the Characteristic Code Table for Unified Addresses within the Query Unified Address Characteristics (Type 185) packet found in the Customer Interface Packet Specification.)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-41 | Reserved | Char(6) |
| 42-45 | Power Down Timer Status | Char(4) |
| 46-49 | Power Down Timer | Char(4) |
| 50-53 | Screen Behavior Status | Char(4) |
| 54-55 | Screen Behavior | Char(2) |
| 56-59 | Beep Control Parameter Status | Char(4) |
| 60-61 | Normal Beep Timer Subs | Char(2) |
| 62-62 | Normal Beep Volume Subs | Char(1) |
| 63-64 | Emergency Beep Timer Subs | Char(2) |
| 65-65 | Emergency Beep Volume Subs | Char(1) |
| 66-66 | Normal Beep Volume Init | Char(1) |
| 67-67 | Emergency Beep Volume Init | Char(1) |
| 68-71 | Mobile Time Zone Status | Char(4) |
| 72-74 | Mobile Time Zone (blank, if 'Mobile in Daylight Savings Time' is blank.) | Char(3) |
| 75-75 | Mobile in Daylight Savings Time | Char(1) |
| 76-79 | Wakeup Timer Status | Char(4) |
| 80-83 | Wakeup Timer Interval | Char(4) |
| 84-87 | Total Wakeup Power Time | Char(4) |
| 88-91 | DTTS Capability Status | Char(4) |
| 92-92 | DTTS Capable | Char(1) |
| 93-96 | DTTS Enable Status | Char(4) |
| 97-97 | DTTS Enable | Char(1) |
| 98-99 | Mobile Time Zone Group | Char(2) |
| 100-101 | Mobile Language Code | Char(2) |
| 102-106 | Reserved | Char(5) |
| 107-110 | MIPR Timeout Status | Char(4) |
| 111-117 | MIPR Timeout (secs) | Char(7) |
| 118-121 | Temporary MIPR Timeout Status | Char(4) |
| 122-128 | Temporary MIPR Timeout (secs) | Char(7) |
| 129-135 | Temporary MIPR Timeout Expire Date | Packed(13,0) |
| 136-139 | Archived Pos Recording Status | Char(4) |
| 140-144 | Archived Pos Recording Interval | Char(5) |
| 145-152 | Archived Pos Recording Hrs of Operation | Char(8) |
| 153-153 | Archived Pos Recording Suppress Ignition Off | Char(1) |
| 154-160 | Archived Pos Recording Expire Date | Packed(13,0) |
VEH500 Data Format (Vehicle miscellaneous information)
(Mobile parameter values are documented in the Characteristic Code Table for Unified Addresses within the Query Unified Address Characteristics (Type 185) packet found in the Customer Interface Packet Specification.)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-36 | TrailerTRACS Enabled | Char(1) |
| 37-37 | SensorTRACS Enabled | Char(1) |
| 38-38 | JTRACS Enabled | Char(1) |
| 39-48 | Customer Account | Char(10) |
| 49-52 | Comm Unit Firmware Version | Packed(7,2) |
| 53-53 | Notify of Ignition Status Change | Char(1) |
| 54-60 | Last Modification | Packed(13,0) |
| 61-70 | Last Modification User | Char(1) |
VEH600 Data Format (Vehicle next/last appointment)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-39 | Next Stop ID | Packed(7,0) |
| 40-46 | Next Stop Appointment Time | Packed(13,0) |
| 47-50 | Last Stop ID | Packed(7,0) |
| 51-57 | Last Stop Appointment Time | Packed(13,0) |
VEH700 Data Format (Vehicle global/driver login parameters)
(Mobile parameter values are documented in the Characteristic Code Table for Unified Addresses within the Query Unified Address Characteristics (Type 185) packet found in the Customer Interface Packet Specification.)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Vehicle Comm Unit Number | Char(10) |
| 46-49 | Global Login Enabled Status | Char(4) |
| 50-50 | Global Login Enabled | Char(1) |
| 51-54 | Number of Retries Status | Char(4) |
| 55-57 | Number of Retries Threshold | Char(3) |
| 58-61 | Distance Exceeded Status | Char(4) |
| 62-64 | Distance Exceeded Threshold (miles) | Char(3) |
| 65-68 | Time Exceeded Status | Char(4) |
| 69-71 | Time Exceeded Threshold (mins) | Char(3) |
| 72-75 | Beep Interval Status | Char(4) |
| 76-78 | Beep Interval (mins) | Char(3) |
| 79-82 | Auto Bump Active Driver Status | Char(4) |
| 83-85 | Auto Bump Active Driver Threshold (hrs) | Char(3) |
| 86-89 | Auto Bump All Drivers Status | Char(4) |
| 90-92 | Auto Bump All Drivers Threshold (hrs) | Char(3) |
| 93-95 | Global Login Distance (kms) | Char(3) |
| 96-101 | Driver Login GMN | Packed(11,0) |
| 102-105 | Driver Login Status | Char(4) |
| 106-106 | Driver Login Enabled | Char(1) |
| 107-112 | Driver Login Active Driver Warning GMN | Packed(11,0) |
| 113-116 | Driver Login Active Driver Warning Status | Char(4) |
| 117-119 | Driver Login Active Driver Warning | Char(3) |
USR100 Data Format (User's message direction, vehicle coverage number and time info)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Redirected To Name | Char(10) |
| 46-48 | Number of Inbound Redirects | Packed(5,0) |
| 49-58 | Vehicle Coverage Number | Char(10) |
| 59-61 | User Time Zone Code | Char(3) |
USR200 Data Format (User capabilities)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-36 | Capability Bits 1-8 | Char(1) |
| 37-37 | Capability Bits 9-16 | Char(1) |
| 38-38 | Capability Bits 17-24 | Char(1) |
| 39-39 | Capability Bits 25-32 | Char(1) |
| 40-40 | Capability Bits 33-40 | Char(1) |
| 41-41 | Capability Bits 41-48 | Char(1) |
| 42-42 | Capability Bits 49-56 | Char(1) |
| 43-43 | Capability Bits 57-64 | Char(1) |
USR300 Data Format (User's message handling defaults)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-36 | Message Default Return Receipt | Char(1) |
| 37-37 | Message Default Forward Message Priority | Char(1) |
| 38-47 | Message Default Reply To | Char(10) |
| 48-48 | Message Default Claim Message | Char(1) |
| 49-49 | Message Default Ignore Claimed Messages | Char(1) |
| 50-51 | Free Form Lines Allowed | Packed(3,0) |
| 52-52 | Append Signature Flag (new for v7.1) | Char(1) |
| 53-90 | Signature Text (new for v7.1) | Char(38) |
LST100 Data Format (Address list vehicle coverage information and statistics)
This table shows the data format for the address list vehicle coverage information and statistics.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Vehicle Coverage Number | Char(10) |
| 46-48 | Number of Vehicles covered by List | Packed(4,0) |
| 49-51 | Number of Users in Address List | Zoned(3) |
LST200 Data Format (Address list members; 1 ST 20)
This table shows the data format for the address list members.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-235 | Member List Array (10x20) | Char(200) |
GRP100 Data Format (Group information)
This table shows the data format for the group information.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Vehicle Message Group Number | Char(10) |
| 46-48 | Number of Vehicles | Packed(4,0) |
AVH100 Data Format (Auxiliary vehicle comm unit number, coverage and group info)
This table shows the data format for the auxiliary vehicle comm unit number, coverage, and group info.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Vehicle Comm Unit Number | Char(10) |
| 46-55 | Vehicle Coverage | Char(10) |
| 56-65 | Vehicle Owner | Char(10) |
AVH200 Data Format (Auxiliary vehicle transmission stats and pending request statuses)
This table shows the data format for the auxiliary vehicle transmission stats and pending request statuses.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-40 | Transmitted Characters | Packed(9,0) |
| 41-45 | Transmitted Messages | Packed(9,0) |
| 46-52 | Time of Last Reset | Packed(13,0) |
| 53-56 | Position Update Request Status | Char(4) |
AVH300 Data Format (Auxiliary vehicle's latest QTRACS position information)
AVH300 Data Format (Auxiliary vehicle's latest QTRACS position information)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-42 | Position Time | Packed(13,0) |
| 43-46 | Latitude (sec) | Packed(7,0) |
| 47-50 | Longitude (secs) | Packed(7,0) |
| 51-51 | Vehicle Ignition Status | Char(1) |
| 52-56 | Position Source Type | Char(5) |
| 57-61 | Latitude (decimal degrees) (added v7.0) | Packed(9.6) |
| 62-66 | Longitude (decimal degrees) (added v7.0) | Packed(9.6) |
AVH400 Data Format (Auxiliary vehicle management parameters)
AVH400 Data Format (Auxiliary vehicle management parameters)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-45 | Cross Reference ID - Name | Char(10) |
| 46-76 | Reserved | Char(31) |
| 77-83 | Reserved | Packed(13,0) |
| 84-114 | Reserved | Char(31) |
AVH500 Data Format (Auxiliary vehicle miscellaneous information)
AVH500 Data Format (Auxiliary vehicle miscellaneous information)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-36 | TrailerTRACS Enabled | Char(1) |
| 37-37 | SensorTRACS Enabled | Char(1) |
| 38-38 | JTRACS Enabled | Char(1) |
| 39-48 | Customer Account | Char(10) |
| 49-52 | Comm Unit Firmware Version | Packed(7,2) |
| 53-53 | Notify of Ignition Status Change | Char(1) |
| 54-60 | Last Modification | Packed(13,0) |
| 61-70 | Last Modification User | Char(10) |
AVH600 Data Format (Auxiliary vehicle next/last appointment)
AVH600 Data Format (Auxiliary vehicle next/last appointment)
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-39 | Next Stop ID | Packed(7,0) |
| 40-46 | Next Stop Appointment Time | Packed(13,0) |
| 47-50 | Last Stop ID | Packed(7,0) |
| 51-57 | Last Stop Appointment Time | Packed(13,0) |
AAC100 Data Format (Auxiliary account information)
This table shows the data format for auxiliary account information.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-39 | SCAC | Char(4) |
| 40-49 | Account Number | Char(10) |
| 50-74 | Account Contact Name | Char(25) |
| 75-99 | Address Line 1 | Char(25) |
| 100-124 | Address Line 2 | Char(25) |
| 125-149 | City | Char(25) |
| 150-151 | State | Char(2) |
| 152-153 | Country | Char(2) |
| 154-162 | Postal Code | Char(9) |
AAC200 Data Format (Auxiliary account comm unit counts)
This table shows the data format for auxiliary account comm unit counts.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-38 | Number of Domestic Comm Units Routed To | Packed(5,0) |
| 39-41 | Number of Foreign Comm Units Routed From | Packed(5,0) |
AAC300 Data Format (Auxiliary account automated vehicle defaults)
This table shows the data format for auxiliary account automated vehicle defaults.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-36 | Automated Vehicle Set Up | Char(1) |
| 37-38 | Automated Vehicle Tear Down | Packed(3,0) |
| 39-48 | Automated Vehicle Default Coverage | Char(10) |
| 49-72 | Automated Vehicle Default Description | Char(24) |
| 73-77 | Automated Vehicle Default Position Source Type | Char(5) |
| 78-108 | Default Forward Message Insertion Text | Char(31) |
| 109-139 | Default Return Message Insertion Text | Char(31) |
DRV100 Data Format (Driver information)
This table shows the data format for driver information.
| 1-10 | Entity Identifier | Char(10) |
| 11-11 | Entity Type Code | Char(1) |
| 12-35 | Entity Name | Char(24) |
| 36-65 | Driver Full Name | Char(30) |
| 66-73 | Global Login Password | Char(8) |
| 74-83 | Currently Logged-In Vehicle | Char(10) |
| 84-90 | Currently Logged-In Time | Packed(13,0) |
| 91-94 | Last Request Status/Subtype 00 | Char(4) |
| 95-99 | Last Request HMN/Subtype 00 | Packed(9,0) |
| 100-103 | Last Request Status/Subtype 01 | Char(4) |
| 104-108 | Last Request HMN/Subtype 01 | Packed(9,0) |
| 109-112 | Last Request Status/Subtype 02 | Char(4) |
| 113-117 | Last Request HMN/Subtype 02 | Packed(9,0) |
| 118-121 | Last Request Status/Subtype 03 | Char(4) |
| 122-126 | Last Request HMN/Subtype 03 | Packed(9,0) |
| 127-130 | Last Request Status/Subtype 04 | Char(4) |
| 131-135 | Last Request HMN/Subtype 04 | Packed(9,0) |
| 136-139 | Last Request Status/Subtype 05 | Char(4) |
| 140-144 | Last Request HMN/Subtype 05 | Packed(9,0) |
| 145-154 | Last Changed by User | Char(10) |
| 155-161 | Last Changed Time | Packed(13,0) |