Request Vehicle Parameter Update - OMRQVPRM
Request Vehicle Parameter Update (OMRQVPRM)
Required Parameter Group:
1 |
Vehicle Identifier |
Input |
Char(10) |
2 |
Return Status |
Output |
Char(1) |
Optional Parameter Group:
3 |
Reset All Parameters |
Input |
Char(1) |
API Overview:
The Request Vehicle Parameter Update API (OMRQVPRM) will format and send a 'Request Parameter Update' transaction to the Communications Manager for one or all vehicles that have been defined in QTRACS. This causes the vehicle's management parameters to be refreshed by querying the NMC.
Required Parameter Group Details:
(1) Vehicle Identifier
INPUT; CHAR(10)
This parameter contains the vehicle identifier for which the parameter update is being requested. Possible values for this field include a single vehicle identifier or the special value *ALL. If *ALL is specified the API will request a parameter update for every vehicle in the QTRACS database.
(2) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
0 |
Success, parameter update requested |
1 |
Failure, vehicle identifier not found |
2 |
Failure, parameter update request is already pending |
3 |
Failure, error occurred writing to Communication Manager's data queue |
4 |
Failure, parameter update not supported for OmniOne vehicles |
Optional Parameter Group Details:
(3) Reset All Parameters
INPUT; CHAR(1)
This parameter indicates whether to reset all vehicle parameters or just the query-only parameters. Valid values are:
0 |
Reset all parameters (default) |
1 |
Reset query-only parameters; includes firmware, account info, component version info, etc. |
If this parameter is not specified by the calling program, the API will execute its default logic; it will operate as if the parameter was passed and '0' was specified.