Rename a QTRACS Vehicle Identifier - OMRNMVEH
Rename a QTRACS Vehicle Identifier (OMRNMVEH) RI
Required Parameter Group:
| 1 | Old Vehicle Identifier | Input | Char(10) |
| 2 | New Vehicle Identifier | Input | Char(10) |
| 3 | Update History | Input | Char(1) |
| 4 | Return Status | Output | Char(1) |
API Overview:
The Rename a QTRACS Vehicle Identifier API (OMRNMVEH) is used to rename an existing QTRACS Vehicle identifier. The option to update all history files to reflect the new name is also available. If so chosen, a job will be submitted to batch to convert the Message and Vehicle Position History Databases to reflect the new vehicle identifier. Otherwise, the history will remain tied to the old vehicle identifier.
Required Parameter Group Details:
(1) Old Vehicle Identifier
INPUT; CHAR(10)
This parameter contains the identifier of the vehicle to be renamed.
(2) New Vehicle Identifier
INPUT; CHAR(10)
This parameter contains the new identifier for the vehicle that is being renamed.
(3) Update History
INPUT; CHAR(1)
This parameter indicates whether to submit a separate batch job to update the QTRACS history databases to reflect the new vehicle identifier. Valid values are:
| Y | Yes, update associated history files to reflect the new vehicle identifier |
| N | No, do not update history records, just rename the vehicle identifier in the vehicle database |
(4) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, vehicle identifier renamed |
| 1 | Success, vehicle identifier renamed and job submitted to batch to convert associated history files |
| 2 | Failure, old vehicle identifier not found |
| 3 | Failure, new vehicle identifier already exists |
| 4 | Failure, old and new vehicle identifier are the same |
| 5 | Failure, new vehicle identifier is invalid |
| 6 | Failure, invalid value specified in update history parameter |
| 7 | Failure, error retrieving configuration record |
| A | Failure, API failed when called remotely |
Effect
A successful call to this API will result in the rename of an existing QTRACS vehicle identifier. If the Update History parameter is set to 'Y' then a job will be submitted to convert all associated message and position history files to reflect the new vehicle id. In addition, all interested external applications are notified that the vehicle has been renamed.