Vehicle->Update
Update (Vehicle Function)
This function updates a single existing vehicle record within the HOS database.
Starting in 6.5 :
- The MCT can only be updated 15 times every 2 hours. If number of changes exceeds 15 within the prior 2 hour window, then the request will be rejected and an error will be returned to the caller. This is to prevent D.O.S. vulnerability.
XML Request
The original load information is provided in the <ov> block while the new load information is provided in the <vd> block. The Update function takes the following request parameters:
Parameter | Type | Description | Notes |
---|---|---|---|
MCT | Integer | The MCT number assigned to the tractor | |
Alias | String | String representing a name for the tractor | If the tag is omitted, no change. If the tag is specified but is empty, the previous value will be removed * |
DepotId | Short | Depot that the tractor belongs to | |
TractorId | String | Unique identifier for this tractor | Though not strictly required, this needs to be populated to prevent ambiguity if a tractorID has been edited |
VIN | String | Vehicle Identification Number (must be 17 characters), optional field | If the tag is omitted, no change. If the tag is specified but is empty, the previous value will be removed * |
VehicleGroup | String | Group the tractor belongs to; if more than one, provide each string on a new line within the <VehicleGroup> tag | If the tag is omitted, no change. If the tag is specified but is empty, the previous value will be removed * |
message | String | String used in XML request to uniquely identify XML response (HOS Web Services United States only) | |
EldMode | Enum | Desired operating mode of the mobile device on the vehicle; Possible Values: "ELD_Mode", "AOBRD_Mode", or null A null value will leave this setting unchanged. |
<soap:Body> <Update xmlns="http://www.qualcomm.com"> <ov> <MCT>int</MCT> <Alias>string</Alias> <DepotId>short</DepotId> <TractorId>string</TractorId> <VIN>string</VIN> <VehicleGroup> <string>string</string> <string>string</string> </VehicleGroup> <EldMode>ELD_Mode or AOBRD_Mode</EldMode> </ov> <vd> <MCT>int</MCT> <Alias>string</Alias> <DepotId>short</DepotId> <TractorId>string</TractorId> <VIN>string</VIN> <VehicleGroup> <string>string</string> <string>string</string> </VehicleGroup> <EldMode>ELD_Mode or AOBRD_Mode</EldMode> </vd> <message>string</message> </Update> </soap:Body>
XML Response
The return result indicates success or failure via SOAP exceptions.
<soap:Body> <UpdateResponse xmlns="http://www.qualcomm.com" /> </soap:Body>