Release Scheduled Message by Vehicle - OMSCDVEH
Release Scheduled Message by Vehicle (OMSCDVEH) RI
Required Parameter Group:
| 1 | Vehicle Identifier | Input | Char(10) |
| 2 | Return Status | Output | Char(1) |
Optional Parameter Group:
| 3 | Number of Messages Released | Output | Integer(4) |
| 4 | Number of Messages Failed | Output | Integer(4) |
API Overview:
The Release Scheduled Message by Vehicle API (OMSCDVEH) will release all scheduled messages for the vehicle specified in the input parameter. This API is intended to be used when QTRACS is configured to release scheduled messages "when a vehicle is awake", however, that is not an enforced rule.
Note: When QTRACS is configured to release scheduled messages "when a vehicle is awake", there is a restriction that scheduled messages may only be sent to a single explicit vehicle. This restriction is enforced at both the user interface and the API interfaces. The reason for this is because a message may be destined for multiple combinations of entities at once (vehicles, users, groups of vehicles, indirect messaging, etc.). It is much more CPU intensive to search the destination nodes of all messages than for a single vehicle destination. And time is a big consideration for this API because it is called frequently by the QTRACS Router and possibly the EAL processes.
Required Parameter Group Details:
(1) Vehicle Identifier
INPUT; CHAR(10)
This parameter contains the identifier of the vehicle who whose scheduled messages should be released.
(2) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, 0 or more messages were released |
| 1 | Failure, one or more messages were rejected |
| A | Failure, API failed when called remotely |
Optional Parameter Group Details:
(3) Number of Messages Released
OUTPUT; INTEGER(4)
This parameter contains number of messages successfully released.
(4) Number of Messages Failed
OUTPUT; INTEGER(4)
This parameter contains the number of messages rejected upon submittal.