Create Default Auxiliary Vehicle - OMDFTAVH
Create Default Auxiliary Vehicle (OMDFTAVH) RI
Required Parameter Group:
| 1 | Company Identifier | Input | Char(15) |
| 2 | Auxiliary Vehicle Identifier | Input | Char(14) |
| 3 | Auxiliary Account Identifier | Input | Char(10) |
| 4 | Customer Reference Number | Input | Char(10) |
| 5 | Auxiliary Vehicle Name | Input | Char(24) |
| 6 | Unified Address | Input | Char(10) |
| 7 | Coverage Identifier | Input | Char(10) |
| 8 | Position Hardware Type | Input | Char(5) |
| 9 | Return Status | Output | Char(1) |
| 10 | Reason Code | Output | Char(4) |
API Overview:
The Create Default Auxiliary Vehicle API (OMDFTAVH) provides a reliable and easy to use mechanism for external applications to add new vehicles to the QTRACS Vehicle Database. This API is designed to be called from a batch environment. It has no interactive display components. Most of the fields in the new vehicle record will be defaulted from the system-wide default vehicle record. The only exceptions are those fields which must be specified as input parameters.
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) Auxiliary Vehicle Identifier
INPUT; CHAR(14)
This parameter must contain a unique identifier, left-justified with the last 4 bytes blank. QTRACS/400 currently only supports 10 byte identifiers; the extra 4 bytes are for future use.
(3) Auxiliary Account Identifier
INPUT; CHAR(10)
This parameter must contain a registered auxiliary account identification that the auxiliary vehicle will be assigned to.
(4) Customer Reference Number
INPUT; CHAR(10)
This parameter is optional but when specified should contain the customer reference number of the auxiliary vehicle.
(5) Auxiliary Vehicle Name
INPUT; CHAR(24)
This parameter is optional. If left blank and the 'auto-create vehicle' flag is *YES, the default vehicle name will be used.
(6) Unified Address
INPUT; CHAR(10)
This parameter must contain a unique unified address number.
(7) Coverage Identifier
INPUT; CHAR(10)
This parameter must contain a registered coverage identifier when the 'auto-create vehicle' flag is *NO. If the 'auto-create vehicle' flag is *YES, this parameter may be left blank and the default value will be used.
(8) Position Hardware Type
INPUT; CHAR(5)
This parameter must contain a registered position hardware type when the 'auto-create vehicle' flag is *NO. If the 'auto-create vehicle' flag is *YES, this parameter may be left blank and the default value will be used.
(9) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, auxiliary vehicle has been created |
| 1 | Failure, auxiliary vehicle has not been created. See reason code. |
| A | Failure, API failed when called remotely |
(10) Reason Code
OUTPUT; CHAR(4)
This parameter contains a reason code. Possible values returned include;
| 0000 | OK |
| 0010 | Auxiliary vehicle identifier's last 4 positions are not blank |
| 0011 | Auxiliary vehicle identifier's first 10 positions are blank |
| 0012 | Auxiliary vehicle identifier is reserved word 'NMC' |
| 0013 | Auxiliary vehicle identifier may not begin with an asterisk |
| 0014 | Auxiliary vehicle identifier contains illegal characters |
| 0015 | Auxiliary vehicle identifier already exists |
| 0021 | Auxiliary account is blank |
| 0022 | Auxiliary account not found |
| 0031 | Unified address is blank or zero |
| 0032 | Unified address is reserved number 0009999999 |
| 0033 | Unified address already exists |
| 0034 | Unified address is not within a valid range |
| 0035 | Unified address cannot be one of the reserved group message numbers |
| 0036 | Unified address contains illegal characters |
| 0041 | Coverage identifier is blank with no 'auto-create' specified |
| 0042 | Coverage identifier is invalid |
| 0051 | Position hardware source is blank with no 'auto-create' specified |
| 0052 | Position hardware source is invalid |
| 0099 | I/O error |
Effect
A successful call to this API will result in the addition of a new auxiliary vehicle to the QTRACS database. Attributes not passed via the parameter list may be filled with the 'auto-create' default values or defaulted to blanks. The status and reason codes will be set and returned to the calling application. After the successful creation of an auxiliary vehicle, a transaction to request a position report is sent to the NMC.