Driver Web Service

Driver

Click here for a complete list of operations.

ExportDriverClockByDepotId

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 reduced amount of data as compared to the 'ExportDriverByDepotId' method and does not require RuleSet parameter. This method uses Driver's current rule set.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /QHOSWSNA/driver.asmx HTTP/1.1
Host: hosx.omnitracs.ca
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.omnitracs.com/ExportDriverClockByDepotId"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ExportDriverClockByDepotId xmlns="http://www.omnitracs.com">
      <request>
        <StartDriverId>string</StartDriverId>
        <DepotId>short</DepotId>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
        <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>
      </request>
    </ExportDriverClockByDepotId>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ExportDriverClockByDepotIdResponse xmlns="http://www.omnitracs.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>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /QHOSWSNA/driver.asmx HTTP/1.1
Host: hosx.omnitracs.ca
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ExportDriverClockByDepotId xmlns="http://www.omnitracs.com">
      <request>
        <StartDriverId>string</StartDriverId>
        <DepotId>short</DepotId>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
        <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>
      </request>
    </ExportDriverClockByDepotId>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ExportDriverClockByDepotIdResponse xmlns="http://www.omnitracs.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>
  </soap12:Body>
</soap12:Envelope>