Driver Web Service

Driver

Click here for a complete list of operations.

ExportDriver

Return one or more driver data based a HOS 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: hos.omnitracs.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.omnitracs.com/ExportDriver"

<?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>
    <ExportDriver xmlns="http://www.omnitracs.com">
      <request>
        <Drivers>
          <string>string</string>
          <string>string</string>
        </Drivers>
        <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
        <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>
      </request>
    </ExportDriver>
  </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>
    <ExportDriverResponse xmlns="http://www.omnitracs.com">
      <ExportDriverResult>
        <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>
      </ExportDriverResult>
    </ExportDriverResponse>
  </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: hos.omnitracs.com
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>
    <ExportDriver xmlns="http://www.omnitracs.com">
      <request>
        <Drivers>
          <string>string</string>
          <string>string</string>
        </Drivers>
        <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
        <UseSplitSleeperCalc>boolean</UseSplitSleeperCalc>
      </request>
    </ExportDriver>
  </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>
    <ExportDriverResponse xmlns="http://www.omnitracs.com">
      <ExportDriverResult>
        <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>
      </ExportDriverResult>
    </ExportDriverResponse>
  </soap12:Body>
</soap12:Envelope>