Add Vehicle to Message Group

Last updated
Save as PDF

addtoMessageGroup

Adds a vehicle to a broadcast message group given the identifier of the vehicle and the identifier of the message group.

void addtoMessageGroup(AssetIdentifier vehicle, String msgGroupId) throws WSException

vehicle: A QTWebServices AssetIdentifier containing the SCAC and ID of the vehicle to be added to the message group.
msgGroupId: The identifier of the broadcast message group to which this vehicle will be added.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use QTRACS
- Can set up vehicle message groups

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<addtoMessageGroup>

<vehicle>

<id>EON01</id>

<scac></scac>

</vehicle>

<msgGroupId>GROUP6</msgGroupId>

</addtoMessageGroup>

</soap:Body>

Sample XML Response

An empty response means success. If there was an error, an exception would have been thrown.

<soapenv:Body>

<addtoMessageGroupResponse/>

</soapenv:Body>

Exceptions

002 Required field not specified.
003 Company not authorized for access through integration.
004 User is not authorized.
005 SCAC is required.
006 SCAC is invalid.
007 Vehicle ID is required.
008 Vehicle not found.
009 Cannot change message groups of an auxiliary vehicle.
010 Invalid operation code value.
011 The message group identifier cannot be blank.
012 Current message group ID cannot be blank.
013 Current and new message group ID?s cannot be the same.
014 Invalid current message group ID, does not exist.
015 Message group does not exist.
016 Vehicle not found.
017 Vehicle is not an owned vehicle.
018 Vehicle is already a member of the message group.
019 Operation exceeds maximum number of vehicles for a message group.
020 Group membership limit exceeded.
021 Vehicle is not a member of the group.
022 Error adding/removing to group membership file.
023 Vehicles without a device cannot be members of a vehicle message group.
024 Invalid function code (returned from a call to API, OMGRPVEH).
025 No vehicles associated with source message group ID, cannot reassign.
026 New message group ID cannot have more than 32,767 vehicles.
027 Invalid vehicle identifier, must be *ALL.
028 Error validating a vehicle in the source group membership on Reassign.
029 Error validating a vehicle in the destination group membership on Reassign.