Skip to main content
Omnitracs Knowledge Base

Vehicle->UpdateEx

UpdateEx (Vehicle Function)

This function updates one or more currently existing vehicle records within the HOS database. If the provided vehicle is not found in the database, the function fails (returns a false result).

XML Request

The notes with * are valid after HOS release 5.8

For multiple vehicle records, each load must have its own <VehicleData> tag. In the <originalVehicles> section, the loads already stored into the database are listed. The updated information should be provided in the <vehicles> block. The UpdateEx function takes the following input 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>  
    <UpdateEx xmlns="http://www.qualcomm.com">  
        <originalVehicles>  
            <VehicleData>  
                <MCT>int</MCT>  
                <Alias>string</Alias>  
                <DepotId>short</DepotId>  
                <TractorId>string</TractorId>  
                <VIN>string</VIN>  
                <VehicleGroup>  
                    <string>string</string>  
                    <string>string</string>  
                </VehicleGroup>  
                <EldMode>AOBRD_Mode or ELD_Mode</ELDMode>  
            </VehicleData>  
            <VehicleData>  
                <MCT>int</MCT>  
                <Alias>string</Alias>  
                <DepotId>short</DepotId>  
                <TractorId>string</TractorId>  
                <VIN>string</VIN>  
                <VehicleGroup>  
                    <string>string</string>  
                    <string>string</string>  
                </VehicleGroup>  
                <EldMode>AOBRD_Mode or ELD_Mode</ELDMode>  
            </VehicleData>  
        </originalVehicles>  
        <vehicles>  
            <VehicleData>  
                <MCT>int</MCT>  
                <Alias>string</Alias>  
                <DepotId>short</DepotId>  
                <TractorId>string</TractorId>  
                <VIN>string</VIN>  
                <VehicleGroup>  
                    <string>string</string>  
                    <string>string</string>  
                </VehicleGroup>  
                <EldMode>AOBRD_Mode or ELD_Mode</ELDMode>  
            </VehicleData>  
            <VehicleData>  
                <MCT>int</MCT>  
                <Alias>string</Alias>  
                <DepotId>short</DepotId>  
                <TractorId>string</TractorId>  
                <VIN>string</VIN>  
                <VehicleGroup>  
                    <string>string</string>  
                    <string>string</string>  
                </VehicleGroup>  
                <EldMode>AOBRD_Mode or ELD_Mode</ELDMode>  
            </VehicleData>  
        </vehicles>  
        <message>string</message>  
    </UpdateEx>  
</soap:Body>  

XML Response

The return result indicates success or failure via SOAP exceptions.

  
<soap:Body>  
    <UpdateExResponse xmlns="http://www.qualcomm.com" />  
</soap:Body>  
  • Was this article helpful?