Vehicle->AddEx

Last updated
Save as PDF

AddEx (Vehicle Function)

This function adds one or more vehicle records.

XML Request

For multiple driver records, each driver must have its own <LoadData> tag. The AddEx function takes the following input parameters:

Parameter	Type	Description
TractorId	String	Tractor assigned to the load
VehicleGroup	String	Group the tractor belongs to; if more than one, provide each string on a new line within the `<VehicleGroup>` tag
MCT	Integer	The MCT number assigned to the tractor
Alias	String	String representing a name for the tractor
DepotId	Short	Depot that the tractor belongs to
TractorId	String	Unique identifier for this tractor
VIN	String	Vehicle Identification Number (must be 17 characters), optional field
VehicleGroup	String	Group the tractor belongs to; if more than one, provide each string on a new line within the `<VehicleGroup>` tag
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; As of Release 5.3, all new vehicles will be set to ELD_Mode, regardless of input value, as long as the unit belongs to customer's account.

  
<soap:Body>  
    <AddEx xmlns="http://www.qualcomm.com">  
        <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>  
    </AddEx>  
</soap:Body>

XML Response

The return result contains the Boolean parameter <AddExResult>, which indicates whether the addition was successful (true) or not (false), followed by the same data given as input.

  
<AddExResponse xmlns="http://www.qualcomm.com">  
    <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>  
</AddExResponse>