Driver->Update

Last updated
Save as PDF

Update (Driver Function)

This function updates one or more currently existing driver records within the HOS database.

XML Request

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

Parameter	Type	Description
DriverId	String	The driver ID for the driver being updated.
UpdateDriverId	String	The new driver ID. Must be at least 4 characters.
Password	String	The driver's password
LastName	String	The driver's last name. Must be at least 2 characters.
FirstName	String	The driver's first name. Must be at least 2 characters.
DepotId	Short	The ID of the depot to which the driver belongs
DriverGroup	String	The group that the driver belongs to; if more than one, provide each string on a new line within the <DriverGroup> tag
DefaultRuleSet	Enum	The default driving rule set for this driver: USA, Canada, or Canada north of the 60th parallel; possible values are USA, CANMain, CANNorth, USACalifornia, USAFlorida, USATexas, USAAlaska
USDefaultDutyCycle	Enum	The driver's default duty cycle for a U.S. rule set; possible values are None (if a Canadian rule set is used), SevenDay, EightDay
CANDefaultDutyCycle	Enum	The driver's default duty cycle for a Canadian rule set; possible values are None (if a U.S. rule set is used), SevenDay, FourteenDay

  
<soap:Body>  
    <Update xmlns="http://www.qualcomm.com">  
        <updateParams>  
            <Driver>  
                <DriverId>string</DriverId>  
                <UpdateDriverId>string</UpdateDriverId>  
                <Password>string</Password>  
                <LastName>string</LastName>  
                <FirstName>string</FirstName>  
                <DepotId>short</DepotId>  
                <DriverGroup>  
                    <string>string</string>  
                    <string>string</string>  
                </DriverGroup>  
                <DefaultRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</DefaultRuleSet>  
                <USDefaultDutyCycle>None or SevenDay or EightDay</USDefaultDutyCycle>  
                <CANDefaultDutyCycle>None or SevenDay or FourteenDay</CANDefaultDutyCycle>  
            </Driver>  
        </updateParams>  
    </Update>  
</soap:Body>

XML Response

The return result contains the Boolean parameter <UpdateResult>, which indicates whether the update was successful (true) or not (false).

  
<soap:Body>  
    <UpdateResponse xmlns="http://www.qualcomm.com">  
        <UpdateResult>  
            <IsUpdated>boolean</IsUpdated>  
        </UpdateResult>  
    </UpdateResponse>  
</soap:Body>