Create Vehicle

Last updated
Save as PDF

createVehicle

Creates a vehicle entry on the Services Portal given an asset identifier, a description of the vehicle and the unit address of the mobile terminal assigned to the new vehicle. All other vehicle attributes will be set to the values of the default vehicle for the company.

void createVehicle(AssetIdentifier vehicle, String vehicleName, String vehicleUA) throws WSException

vehicle A QTWebServices AssetIdentifier containing the SCAC and ID of the vehicle to be created:
vehicleName: A string containing a description of the vehicle being created.

vehicleUA: A string containing the serial number (unit address) of the mobile terminal to be associated with the new vehicle. Unit addresses are strings containing all digits of maximum length 10. Valid ranges for the unit address are:

MCT:	0000000001 : 0009999998
IVG:	0108000001 : 0108999999
MCP:	0100000001 : 0109999998

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 vehicles
OR
- Can use Performance Monitoring
- Can maintain vehicles and drivers

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>

<createVehicle>

<vehicle>

<id>A00003</id>

<scac></scac>

</vehicle>

<vehicleName>Test Vehicle A00003</vehicleName>

<vehicleUA>0100009007</vehicleUA>

</createVehicle>

</soap:Body>

Sample XML Response

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

<soapenv:Body>

<createVehicleResponse/>

</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 ID is invalid.
009 First character in Vehicle ID cannot be an asterisk.
010 Vehicle ID cannot be the ID of the NMC.
011 Vehicle identifier is already in use.
012 Vehicle identifier is already in use as a user identifier.
013 Vehicle identifier is already in use as an address list identifier.
014 Vehicle identifier is already in use as an external application identifier.
015 Vehicle identifier is already in use as a message group identifier.
016 Vehicle identifier is already in use as an auxiliary account identifier.
017 Vehicle identifier is already in use as an auxiliary vehicle identifier.
018 Vehicle identifier is already in use as a driver identifier.
019 Vehicle UA cannot be the reserved unit address.
020 Vehicle UA is already assigned.
021 Vehicle UA is one of the reserved group numbers.
022 Internal error: Call to the Create Vehicle API failed.
023 Vehicle description exceeds limit of 24 characters.
024 Vehicle UA is out of range.