Driver->GetRolloffTime

Last updated
Save as PDF

GetRolloffTime

This function returns the hours gained at midnight by drivers, today and tomorrow. Results will be returned for the requested driver IDs. If the requested driver ID does not exist the result for that driver ID will be omitted. Each invocation can only pass in maximum of 1000 driver IDs. If the input has more than 1000 IDs then an exception will be thrown.

XML Request

The GetRollOffTime function takes one parameter

Parameter	Type	Description
DriverIdList	string	An array of driver IDs for which hours gained information is required.

  
<soap:Body>  
    <GetRollOffTime xmlns="http://www.qualcomm.com">  
      <RequestParams>  
        <DriverIdList>  
          <string>string</string>  
          <string>string</string>  
        </DriverIdList>  
      </RequestParams>  
    </GetRollOffTime>  
</soap:Body>

XML Response

The GetRolloffTime function returns the following values:

Parameter	Type	Description
DriverId	string	The driver's Id
RollOfToday	int	Time in minutes that will be gained at the end of current day.
RollOffTomorrow	int	Time in minutes that will be gained at the end of next day.

  
<soap:Body>  
    <GetRollOffTimeResponse xmlns="http://www.qualcomm.com">  
      <GetRollOffTimeResult>  
        <RollOffTimesList>  
          <RollOffTime>  
            <DriverId>string</DriverId>  
            <RollOfToday>int</RollOfToday>  
            <RollOffTomorrow>int</RollOffTomorrow>  
          </RollOffTime>  
          <RollOffTime>  
            <DriverId>string</DriverId>  
            <RollOfToday>int</RollOfToday>  
            <RollOffTomorrow>int</RollOffTomorrow>  
          </RollOffTime>  
        </RollOffTimesList>  
      </GetRollOffTimeResult>  
    </GetRollOffTimeResponse>  
  </soap:Body>