Maintain QMASS Routing Assignment - OMQMSRA
Maintain QMASS Routing Assignment (OMQMSRA)
Required Parameter Group:
| 1 | Function Code | Input | Char(1) |
| 2 | Vehicle Identifier | Input | Char(10) |
| 3 | Profile Identifier | Input | Char(10) |
| 4 | Forward Message Insertion Text | Input | Char(30) |
| 5 | Return Message Insertion Text | Input | Char(30) |
| 6 | Reason Code | Output | Char(4) |
API Overview:
The Maintain QMASS Routing Assignment API (OMQMSRA) is used to create, delete, and modify QMASS routing assignments. The customer has the option of allowing messages and position data from/to one of his own vehicles to be carbon-copied to an auxiliary account. To enable carbon-copies to an auxiliary account, a QMASS routing assignment must be defined. This API will send the appropriate routing packet to the NMC to enable QMASS for the specified vehicle.
Required Parameter Group Details:
(1) Function Code
INPUT; CHAR(1)
This parameter is a function code that instructs the API what action to perform. Valid values are:
| C | Create routing assignment |
| 2 | Change routing assignment (message insertion text only) |
| 4 | Delete routing assignment |
| X | Delete all routing assignments for the specified vehicle |
(2) Vehicle Identifier
INPUT; CHAR(10)
This parameter contains a valid owned vehicle. Or, this field may contain the special *FLEET wildcard value to specify the entire fleet of vehicles.
(3) Profile Identifier
INPUT; CHAR(10)
This parameter contains the identifier of a QMASS account profile. This profile when paired with an owned vehicle forms a routing assignment. If the function code is 'X', this parameter should be set to blanks.
(4) Forward Message Insertion Text
INPUT; CHAR(30)
This parameter contains optional text to include as a header in all forward messages sent to the vehicle from the auxiliary account associated to the profile above. This text is displayed in both the QTRACS message body of the account owning the vehicle and on the mobile unit. It is also contained in packets delivered to external applications.
(5) Return Message Insertion Text
INPUT; CHAR(30)
This parameter contains optional text to include as a header in return messages routed to the auxiliary account (if the auxiliary account is enabled to receive copies of return packets). When the owning account sends or receives a message from the vehicle, this text header will be returned to the auxiliary account associated to the profile above.
(6) Reason Code
OUTPUT; CHAR(4)
Status value returned to the caller will be set as follows:
| 0000 | Success, routing packet sent to NMC |
| 0001 | Failure, QMASS is not enabled |
| 0002 | Failure, invalid function code specified |
| 0003 | Failure, invalid vehicle identifier specified |
| 0004 | Failure, invalid profile identifier specified |
| 0005 | Failure, invalid characters in forward message insertion text |
| 0006 | Failure, invalid characters in return message insertion text |
| 0007 | Failure, cannot create *FLEET routing assignment because other routing assignments already exist for the given auxiliary account |
| 0008 | Failure, cannot create vehicle routing assignment because the input vehicle is already routed to the given auxiliary account |
| 0009 | Failure, maximum 10 routing assignments already exist for this vehicle or fleet |