Load->Update
Update (Load Function)
This function updates a single existing load record within the HOS system.
XML Request
The original load information is provided in the <od> block while the new load information is provided in the <ld> block. The Update function takes the following request parameters:
| Parameter | Type | Description |
|---|---|---|
| LoadId | String | The load's unique identifier |
| LoadTime | dateTime | Time stamp (in GMT) indicating when the load was loaded on to the tractor-trailer |
| UnLoadTime | dateTime | Time stamp (in GMT) indicating when the load was unloaded from the tractor-trailer |
| TrailerIds | String | Trailers assigned to the load (may be more than one) |
| TractorId | String | Tractor assigned to the load |
| LoadDescriptionType | Unsigned Byte | Type of load description: 1=Bill of lading, 2=Shipping document, 3=Shipper address and commodity |
| LoadDescription | String | Text of the load description, such as a bill of lading |
| DriverId | String | Driver's HOS ID, optional for the web service to function but REQUIRED for actual implementation |
<soap:Body>
<Update xmlns="http://www.qualcomm.com">
<od>
<LoadId>string</LoadId>
<LoadTime>dateTime</LoadTime>
<UnLoadTime>dateTime</UnLoadTime>
<TrailerIds>string</TrailerIds>
<TractorId>string</TractorId>
<LoadDescriptionType>unsignedByte</LoadDescriptionType>
<LoadDescription>string</LoadDescription>
<DriverId>string</DriverId>
</od>
<ld>
<LoadId>string</LoadId>
<LoadTime>dateTime</LoadTime>
<UnLoadTime>dateTime</UnLoadTime>
<TrailerIds>string</TrailerIds>
<TractorId>string</TractorId>
<LoadDescriptionType>unsignedByte</LoadDescriptionType>
<LoadDescription>string</LoadDescription>
<DriverId>string</DriverId>
</ld>
</Update>
</soap:Body>
Additional Info
When calling Update, you need to provide the following values in the original load:
- DriverId
- LoadTime
- LoadId
If the customer does not provide the DriverId (not recommended), then only LoadId is required. In that case, the LoadId needs to be unique for all loads for that customer for the past six months.
Can't change driver. Driver and Vehicle are validated so they must be valid identifiers.
There is no way to 'delete' a load. All that can be done is to set the load and unload time > 200 days ago and let the purge take care of it. Moving it to a way past date does not cause any issues in the system.
XML Response
The return result indicates success or failure via SOAP exceptions.
<soap:Body> <UpdateResponse xmlns="http://www.qualcomm.com" /> </soap:Body>