Change Vehicle Message Group

Last updated
Save as PDF

changeVehicleMessageGroup

This web service allows the a vehicle's message group assignment to be changed. In short, the vehicle is removed from the current message group and reassigned to the new group that has been specified on the call.

void changeVehicleMessageGroup(AssetIdentifier vehicle, String curGroup, String newGroup) throws WSException

vehicle: A QTWebServices AssetIdentifier containing the SCAC and ID of the vehicle whose message group is to be changed.
curGroup: Identifier of a message group to which this vehicle is already assigned. The vehicle will be removed from this group.
newGroup: Identifier of the message group to which this vehicle will be assigned.

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>

<changeMessageGroup>

<vehicle>

<id>EON01</id>

<scac></scac>

</vehicle>

<curGroup>GROUP8</curGroup>

<newGroup>GROUP1</newGroup>

</changeMessageGroup>

</soap:Body>

Sample XML Request

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

<soapenv:Body>

<changeMessageGroupResponse/>

</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 Current message group ID cannot be blank.
011 New message group ID cannot be blank.
012 Current and new message group ID's cannot be the same.
013 Invalid current message group ID, does not exist.
014 Invalid new message group ID, does not exist.
015 Vehicle is already a member of the new message group specified.
016 Vehicle is not a member of the current group specified.
017 Group membership limit exceeded.
018 New message group ID cannot have more than 32,767 vehicles.
019 Error adding/removing to group membership file
020 Vehicle is not an owned vehicle.
021 Vehicles without a device cannot be members of a vehicle message group.