Delete a QTRACS Vehicle - OMDLTVEH
Delete a QTRACS Vehicle (OMDLTVEH) RI
Required Parameter Group:
1 | Company Identifier | Input | Char(15) |
2 | Vehicle Identifier | Input | Char(14) |
3 | Return Status | Output | Char(1) |
4 | Reason Code | Output | Char(4) |
API Overview:
The Delete a QTRACS Vehicle API (OMDLTVEH) is used to delete a vehicle from the QTRACS database. This API is meant to be called in batch mode. It can be used to delete either an owned or an auxiliary QTRACS vehicle. This API provides a reliable and easy to use mechanism for external applications to delete a vehicle from the QTRACS database.
Required Parameter Group Details:
(1) Company Identifier
INPUT; CHAR(15)
This parameter contains a company identifier. It is for future use and is currently ignored.
(2) Vehicle Identifier
INPUT; CHAR(14)
This parameter must contain an owned or auxiliary vehicle identifier. The identifier must contain a left-justified identifier in the first 10 bytes with the last 4 bytes blank.
(3) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
0 | Success, vehicle has been deleted |
1 | Failure, vehicle has not been deleted. See reason code. |
A | Failure, API failed when called remotely |
(4) Reason Code
OUTPUT; CHAR(4)
This parameter contains a reason code. Possible values returned include;
0000 | OK |
0010 | Vehicle identifier's last 4 positions are not blank |
0011 | Vehicle identifier's first 10 positions are blank |
0012 | Vehicle identifier does not exist |
0013 | Vehicle identifier has a QMASS routing assignment |
Effect
A successful call to this API will result in the deletion of a vehicle from the QTRACS Vehicle Database. The status and reason codes will be set and returned to the calling application. After the successful deletion of an owned vehicle, a transaction is sent to the NMC to delete the vehicle from any group that the vehicle might have been associated with.