Driver Web Service

Driver

Click here for a complete list of operations.

ExportDriverByDepotId

Returns one or more Export Driver data objects based on the DepotID provided and greater than the value provided in driverId.

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/ExportDriverByDepotId"

<?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>
    <ExportDriverByDepotId xmlns="http://www.omnitracs.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>
        <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>
      </request>
    </ExportDriverByDepotId>
  </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>
    <ExportDriverByDepotIdResponse xmlns="http://www.omnitracs.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>
</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>
    <ExportDriverByDepotId xmlns="http://www.omnitracs.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>
        <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>
      </request>
    </ExportDriverByDepotId>
  </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>
    <ExportDriverByDepotIdResponse xmlns="http://www.omnitracs.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>
  </soap12:Body>
</soap12:Envelope>