Driver->ExportDriverClockByDepotId

Last updated
Save as PDF

ExportDriverClockByDepotId(Driver Function)

This function returns one or more Export Driver Clock data objects based on the DepotID provided and greater than the value provided in <driverId>. This method returns a reduced amount of data as compared to the ExportDriverByDepotId method. It only returns data relevant to clock functions. It does not require the <RuleSet> parameter. This method uses Driver's current rule set.

UseSplitSleeperCalc: This parameter specifies whether the available hours clocks returned use the Optimistic or Pessimistic calculation. Optimistic assumes the driver will take the second qualifying section of the split sleeper, so the clock should be calculated to give the driver credit for the split sleeper, even if the driver has not taken the second part yet, but does have a section of sleeper that qualified as the first part of the split sleeper.
The default value if not supplied = false. Use Pessimistic clock.

XML Request

The request XML looks like this:

<soap:Body>  
    <ExportDriverClockByDepotId xmlns="http://www.qualcomm.com">  
        <request>  
            <StartDriverId>string</StartDriverId>  
            <DepotId>short</DepotId>  
            <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>  
            <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>  
        </request>  
    </ExportDriverClockByDepotId>  
</soap:Body>

XML Response

The XML returned by this function looks like the following:

<soap:Body>  
    <ExportDriverClockByDepotIdResponse xmlns="http://www.qualcomm.com">  
      <ExportDriverClockByDepotIdResult>  
        <DriverExportClock>  
          <DriverExportClockData>  
            <DriverId>string</DriverId>  
            <DayRestBreak>int</DayRestBreak>  
            <DayDrive>int</DayDrive>  
            <DayDuty>int</DayDuty>  
            <WeekDuty>int</WeekDuty>  
            <DayOff>int</DayOff>  
            <Shift>int</Shift>  
            <WorkLeft>int</WorkLeft>  
            <TwentyFourHourResetEnabled>boolean</TwentyFourHourResetEnabled>  
            <WaitInOilWellEnabled>boolean</WaitInOilWellEnabled>  
            <HazmatLoadEnabled>boolean</HazmatLoadEnabled>  
            <LastAvailHoursRecalc>dateTime</LastAvailHoursRecalc>  
            <USDutyCycle>None or SevenDay or EightDay</USDutyCycle>  
            <CANDutyCycle>None or SevenDay or FourteenDay</CANDutyCycle>  
            <CurrentRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</CurrentRuleSet>  
            <CycleResetTime>dateTime</CycleResetTime>  
            <NextQualifyingUsCycleResetStart>dateTime</NextQualifyingUsCycleResetStart>  
            <ContiguousActivityDuration>int</ContiguousActivityDuration>  
            <ContiguousNonworkingDuration>int</ContiguousNonworkingDuration>  
            <RestBreakExemptionEnabled>boolean</RestBreakExemptionEnabled>  
            <SixteenHourExemptionEnabled>boolean</SixteenHourExemptionEnabled>  
            <CurrentlyUsingRestBreakExemption>boolean</CurrentlyUsingRestBreakExemption>  
          </DriverExportClockData>  
          <DriverExportClockData>  
            <DriverId>string</DriverId>  
            <DayRestBreak>int</DayRestBreak>  
            <DayDrive>int</DayDrive>  
            <DayDuty>int</DayDuty>  
            <WeekDuty>int</WeekDuty>  
            <DayOff>int</DayOff>  
            <Shift>int</Shift>  
            <WorkLeft>int</WorkLeft>  
            <TwentyFourHourResetEnabled>boolean</TwentyFourHourResetEnabled>  
            <WaitInOilWellEnabled>boolean</WaitInOilWellEnabled>  
            <HazmatLoadEnabled>boolean</HazmatLoadEnabled>  
            <LastAvailHoursRecalc>dateTime</LastAvailHoursRecalc>  
            <USDutyCycle>None or SevenDay or EightDay</USDutyCycle>  
            <CANDutyCycle>None or SevenDay or FourteenDay</CANDutyCycle>  
            <CurrentRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</CurrentRuleSet>  
            <CycleResetTime>dateTime</CycleResetTime>  
            <NextQualifyingUsCycleResetStart>dateTime</NextQualifyingUsCycleResetStart>  
            <ContiguousActivityDuration>int</ContiguousActivityDuration>  
            <ContiguousNonworkingDuration>int</ContiguousNonworkingDuration>  
            <RestBreakExemptionEnabled>boolean</RestBreakExemptionEnabled>  
            <SixteenHourExemptionEnabled>boolean</SixteenHourExemptionEnabled>  
            <CurrentlyUsingRestBreakExemption>boolean</CurrentlyUsingRestBreakExemption>  
          </DriverExportClockData>  
        </DriverExportClock>  
        <DepotId>short</DepotId>  
      </ExportDriverClockByDepotIdResult>  
    </ExportDriverClockByDepotIdResponse>  
  </soap:Body>