Enable Vehicle for SensorTRACS
enableVehicleForST
Enables an existing QTRACS vehicle for Performance Monitoring given an asset identifier. An optional description of the vehicle, parameter type and manager may be specified.
void enableVehicleForST(AssetIdentifier vehicle, String vehicleName, String vehicleParmType, String vehicleManagementGroup) throws WSException
- vehicle: An AssetIdentifier containing the SCAC and ID of the vehicle being enabled for SensorTRACS.
- vehicleName: A string that optionally contains a description of the vehicle.
- vehicleParmType: A string that optionally contains the vehicle's SensorTRACS parameter type. If none specified, the reserved parameter type is assigned by default.
- vehicleManagementGroup: A string that contains the identifier of the performance management group to which the vehicle belongs. Blanks are valid and indicate that the vehicle is not part of a management group.
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 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.
|
|
Sample XML Response
An empty response conveys success. If there was an error, an exception would have been thrown.
|
|
Exceptions
001 Unknown Error.
002 Required field not specified.
003 Company not authorized for access through integration.
004 User is not authorized.
005 Vehicle invalid.
006 Vehicle Name invalid.
007 Vehicle Parameter Type invalid.
008 Vehicle Management Group invalid.
009 Vehicle is already enabled.
010 Vehicle does not exist in the QTRACS database.
011 Invalid mobile serial number.
012 Cannot enable SensorTRACS for vehicles without a device.