Skip to main content
Omnitracs Knowledge Base

Driver->ExportDriverByDepotId

ExportDriverByDepotId(Driver Function)

This function returns a list of drivers based on the Depot ID and rule set provided.

Up to 20 records are returned per invocation. The returned list of drivers begins with the first Driverid value falling alphabetically after the specified StartDriverId, and the string passed as StartDriverId does not have to be a valid Driverid. So, to return an entire list of drivers for a given depot, where the number of drivers exceeds 20, you could pass in "0" as the initial StartDriverId parameter to return the first 20 driver records, and then used the last Driverid returned by each invocation as the StartDriverId parameter for the next one until you receive a response containing less than 20 drivers.

XML Request

The ExportDriverByDepotId function takes the following input parameters:

Parameter Type Description
StartDriverId String The first driver ID requested
RuleSet USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska The rule set used for related values returned
DepotId Short The ID of the depot to which the requested drivers belong
TimeResolutionInSeconds Boolean This parameter specifies whether certain values in the response are returned in seconds or minutes. If true, values are returned in seconds; otherwise in minutes. The ELD duty status values Personal Conveyance and Yard Move are also returned if this parameter is true; otherwise, they are returned as Off Duty and On Duty, respectively. This parameter is optional. If the parameter is omitted, then values in the response are returned in minutes. See the response description for the affected fields.
<soap:Body>  
  <ExportDriverByDepotId xmlns="http://www.qualcomm.com">  
    <request>  
      <StartDriverId>string</StartDriverId>  
      <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>  
      <DepotId>short</DepotId>  
      <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>  
    </request>  
  </ExportDriverByDepotId>  
</soap:Body>  

XML Response

The XML response will have a <DriverExportData> section for each driver record. The ExportDriverByDepotId function returns the following values:

Parameter Type Description
DriverId String The driver's ID
Password String The driver's password
LastName String The driver's last name
FirstName String The driver's first name
DepotId Short The ID of the depot to which the driver belongs
TractorId String The tractor currently assigned to the driver
ActivityStarted dateTime The time (expressed as the local time at the driver's depot) when the last activity was begun (if TimeResolutionInSeconds is false or omitted in the request, then ActivityStarted will be truncated to the minute)
DayRestBreak Integer Amount of time available on rest break clock. Ignore this if specified rule-set does not comply with US rest break rule (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)
DayDrive Integer Number of minutes of available driving time remaining
DayDuty Integer Number of minutes of on-duty time remaining
WeekDuty Integer Number of minutes remaining in total cumulative on-duty time for the week
DayOff Integer (Canadian rules only) Number of minutes remaining before driver must take an offduty period of at least 24 hours
Shift Integer (Canadian rules only) Number of minutes remaining on the 16- or 20-hour shift clock
WorkLeft Integer (Canadian rules only) Work time left
OptimisticShift Integer (Canadian rules only) Optimistic shift clock
DailyOffDuty Integer (Canadian rules only) Qualifying daily off duty
DailyTwoHourOffDuty Integer (Canadian main rules only) Daily off outside of an 8 hour shift reset block
OffDutyDeferral None, Day1 or Day2 (Canadian main rules only) Deferral status
LastAvailHoursRecalc dateTime Timestamp (expressed as the local time at the driver's depot) for when the various times remaining are updated with the driver's current duty logs
TodayOnDuty Integer Total time spent on-duty today starting at the depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes) (includes Yard Move durations)
TodayOffDuty Integer Total time spent off-duty today starting at the depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes) (includes Personal Conveyance durations)
TodaySleeper Integer Total time spent in the sleeper berth duty status starting at the depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)
TodayDrive Integer Total time spent driving starting at the depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)
YesterdayOnDuty Integer Total time spent on-duty yesterday starting at depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes) (includes Yard Move durations)
YesterdayOffDuty Integer Total time spent off-duty yesterday starting at depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes) (includes Personal Conveyance durations)
YesterdaySleeper Integer Total time spent in the sleeper berth yesterday starting at depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)
YesterdayDrive Integer Total time spent driving yesterday starting at depot's DOT Start of Day (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)
Activity Integer Driver's current duty status: 1=Off Duty, 2=Sleeper Berth, 3=Driving, 4=On Duty, Not Driving, 5=Off Duty Driving (optional status), 6= Personal Conveyance, 7=Yard Move
TimeZone String The time zone of the driver's depot
USDutyCycle Enum The driver's duty cycle for a U.S. rule set; possible values are None (if a Canadian rule set is used), SevenDay, EightDay
CANDutyCycle Enum The driver's duty cycle for a Canadian rule set; possible values are None (if a U.S. rule set is used), SevenDay, FourteenDay
CurrentRuleSet USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska The current driving rule set used by this driver.
TwentyFourHourResetEnabled Boolean Driver can take 24 hour reset.
WaitInOilWellEnabled Boolean Driver can or cannot wait at oil well.
HazmatLoadEnabled Boolean Driver is enabled or disabled to take rest break while on-duty carrying hazmat loads. This setting is only applicable when driver is under a rule- set that complies with the US rest break rules.
CycleResetTime dateTime Driver's last 34-hour reset (in driver's depot time zone). If omitted, there is no known reset in driver's current duty cycle
NextQualifyingUsCycleResetStart dateTime Driver's next (optimal) qualifying start time (in driver's depot time zone). Omitted under certain conditions, such as not applicable for driver's current rule set or a recent time zone change
ContiguousActivityDuration Int Time (in minutes) a driver has been in current duty status (combining adjacent duty statuses of the same type). -1 is returned when the time is longer than the current duty cycle
ContiguousNonworkingDuration Int Time (in minutes) a driver has been in a consecutive (contiguous) combination of any non-working statuses (off duty, sleeper berth, and personal conveyance). -1 is returned when the time is longer than the current duty cycle, 0 is returned when the driver's current status is a working status
RestBreakExemptionEnabled Boolean Flag that indicates whether the driver is permitted to use the Rest Break Exemption.
SixteenHourExemptionEnabled Boolean Flag that determines if a driver is enabled for 16-hour exemption.
CurrentlyUsingRestBreakExemption Boolean Flag that indicates whether the driver is currently using the Rest Break Exemption.
<soap:Body>  
    <ExportDriverByDepotIdResponse xmlns="http://www.qualcomm.com">  
      <ExportDriverByDepotIdResult>  
        <DriverExport>  
          <DriverExportData>  
            <DriverId>string</DriverId>  
            <Password>string</Password>  
            <LastName>string</LastName>  
            <FirstName>string</FirstName>  
            <DepotId>short</DepotId>  
            <TractorId>string</TractorId>  
            <ActivityStarted>dateTime</ActivityStarted>  
            <DayRestBreak>int</DayRestBreak>  
            <DayDrive>int</DayDrive>  
            <DayDuty>int</DayDuty>  
            <WeekDuty>int</WeekDuty>  
            <DayOff>int</DayOff>  
            <Shift>int</Shift>  
            <WorkLeft>int</WorkLeft>  
            <OptimisticShift>int</OptimisticShift>  
            <DailyOffDuty>int</DailyOffduty>  
            <DailyTwoHourOffDuty>int</DailyTwoHourOffDuty>  
            <OffDutyDeferral>None or Day1 or Day2</OffDutyDeferral>  
            <LastAvailHoursRecalc>dateTime</LastAvailHoursRecalc>  
            <TodayOnDuty>int</TodayOnDuty>  
            <TodayOffDuty>int</TodayOffDuty>  
            <TodaySleeper>int</TodaySleeper>  
            <TodayDrive>int</TodayDrive>  
            <YesterdayOnDuty>int</YesterdayOnDuty>  
            <YesterdayOffDuty>int</YesterdayOffDuty>  
            <YesterdaySleeper>int</YesterdaySleeper>  
            <YesterdayDrive>int</YesterdayDrive>  
            <Activity>int</Activity>  
            <TimeZone>string</TimeZone>  
            <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>  
            <TwentyFourHourResetEnabled>boolean</TwentyFourHourResetEnabled>  
            <WaitInOilWellEnabled>boolean</WaitInOilWellEnabled>  
            <HazmatLoadEnabled>boolean</HazmatLoadEnabled>  
            <CycleResetTime>dateTime</CycleResetTime>  
            <NextQualifyingUsCycleResetStart>dateTime</NextQualifyingUsCycleResetStart>  
            <ContiguousActivityDuration>int</ContiguousActivityDuration>  
            <ContiguousNonworkingDuration>int</ContiguousNonworkingDuration>  
            <RestBreakExemptionEnabled>boolean</RestBreakExemptionEnabled>  
            <SixteenHourExemptionEnabled>boolean</SixteenHourExemptionEnabled>  
            <CurrentlyUsingRestBreakExemption>boolean</CurrentlyUsingRestBreakExemption>  
          </DriverExportData>  
          <DriverExportData>  
            <DriverId>string</DriverId>  
            <Password>string</Password>  
            <LastName>string</LastName>  
            <FirstName>string</FirstName>  
            <DepotId>short</DepotId>  
            <TractorId>string</TractorId>  
            <ActivityStarted>dateTime</ActivityStarted>  
            <DayRestBreak>int</DayRestBreak>  
            <DayDrive>int</DayDrive>  
            <DayDuty>int</DayDuty>  
            <WeekDuty>int</WeekDuty>  
            <DayOff>int</DayOff>  
            <Shift>int</Shift>  
            <WorkLeft>int</WorkLeft>  
            <OptimisticShift>int</OptimisticShift>  
            <DailyOffDuty>int</DailyOffduty>  
            <DailyTwoHourOffDuty>int</DailyTwoHourOffDuty>  
            <OffDutyDeferral>None or Day1 or Day2</OffDutyDeferral>  
            <LastAvailHoursRecalc>dateTime</LastAvailHoursRecalc>  
            <TodayOnDuty>int</TodayOnDuty>  
            <TodayOffDuty>int</TodayOffDuty>  
            <TodaySleeper>int</TodaySleeper>  
            <TodayDrive>int</TodayDrive>  
            <YesterdayOnDuty>int</YesterdayOnDuty>  
            <YesterdayOffDuty>int</YesterdayOffDuty>  
            <YesterdaySleeper>int</YesterdaySleeper>  
            <YesterdayDrive>int</YesterdayDrive>  
            <Activity>int</Activity>  
            <TimeZone>string</TimeZone>  
            <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>  
            <TwentyFourHourResetEnabled>boolean</TwentyFourHourResetEnabled>  
            <WaitInOilWellEnabled>boolean</WaitInOilWellEnabled>  
            <HazmatLoadEnabled>boolean</HazmatLoadEnabled>  
            <CycleResetTime>dateTime</CycleResetTime>  
            <NextQualifyingUsCycleResetStart>dateTime</NextQualifyingUsCycleResetStart>  
            <ContiguousActivityDuration>int</ContiguousActivityDuration>  
            <ContiguousNonworkingDuration>int</ContiguousNonworkingDuration>  
            <RestBreakExemptionEnabled>boolean</RestBreakExemptionEnabled>  
            <SixteenHourExemptionEnabled>boolean</SixteenHourExemptionEnabled>  
            <CurrentlyUsingRestBreakExemption>boolean</CurrentlyUsingRestBreakExemption>  
          </DriverExportData>  
        </DriverExport>  
      </ExportDriverByDepotIdResult>  
    </ExportDriverByDepotIdResponse>  
  </soap:Body>  
  • Was this article helpful?