Driver Web Service

Driver

Click here for a complete list of operations.

DriverViolationsByGroup

Returns violations for specified driver group for the time period indicated. Time period must be no longer than one month. To check for all groups, use '- All -' (dash, space, All, space, dash - no quotes).

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

<?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>
    <DriverViolationsByGroup xmlns="http://www.omnitracs.com">
      <request>
        <Group>string</Group>
        <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>
        <Start>dateTime</Start>
        <End>dateTime</End>
        <CalculatePriorToEdits>boolean</CalculatePriorToEdits>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
      </request>
    </DriverViolationsByGroup>
  </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>
    <DriverViolationsByGroupResponse xmlns="http://www.omnitracs.com">
      <DriverViolationsByGroupResult>
        <Group>string</Group>
        <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>
        <DriverCount>int</DriverCount>
        <Violations>
          <DriverViolationsByGroupData>
            <DriverId>string</DriverId>
            <TimeZone>string</TimeZone>
            <RestBreakViolations>int</RestBreakViolations>
            <DrivingViolations>int</DrivingViolations>
            <OnDutyViolations>int</OnDutyViolations>
            <CumulativeOnDutyViolations>int</CumulativeOnDutyViolations>
            <ShiftViolations>int</ShiftViolations>
            <DayOffViolations>int</DayOffViolations>
            <PassengerRuleViolations>int</PassengerRuleViolations>
            <DailyOffViolations>int</DailyOffViolations>
            <DailyOffTwoHourViolations>int</DailyOffTwoHourViolations>
            <DeferralDrivingViolations>int</DeferralDrivingViolations>
            <TotalOffDutyForDeferralViolations>int</TotalOffDutyForDeferralViolations>
            <DeferralDay1OffDutyViolations>int</DeferralDay1OffDutyViolations>
            <DeferralDay2OffDutyViolations>int</DeferralDay2OffDutyViolations>
            <RestBreakAfterExemptionViolations>int</RestBreakAfterExemptionViolations>
            <Violations xsi:nil="true" />
          </DriverViolationsByGroupData>
          <DriverViolationsByGroupData>
            <DriverId>string</DriverId>
            <TimeZone>string</TimeZone>
            <RestBreakViolations>int</RestBreakViolations>
            <DrivingViolations>int</DrivingViolations>
            <OnDutyViolations>int</OnDutyViolations>
            <CumulativeOnDutyViolations>int</CumulativeOnDutyViolations>
            <ShiftViolations>int</ShiftViolations>
            <DayOffViolations>int</DayOffViolations>
            <PassengerRuleViolations>int</PassengerRuleViolations>
            <DailyOffViolations>int</DailyOffViolations>
            <DailyOffTwoHourViolations>int</DailyOffTwoHourViolations>
            <DeferralDrivingViolations>int</DeferralDrivingViolations>
            <TotalOffDutyForDeferralViolations>int</TotalOffDutyForDeferralViolations>
            <DeferralDay1OffDutyViolations>int</DeferralDay1OffDutyViolations>
            <DeferralDay2OffDutyViolations>int</DeferralDay2OffDutyViolations>
            <RestBreakAfterExemptionViolations>int</RestBreakAfterExemptionViolations>
            <Violations xsi:nil="true" />
          </DriverViolationsByGroupData>
        </Violations>
      </DriverViolationsByGroupResult>
    </DriverViolationsByGroupResponse>
  </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>
    <DriverViolationsByGroup xmlns="http://www.omnitracs.com">
      <request>
        <Group>string</Group>
        <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>
        <Start>dateTime</Start>
        <End>dateTime</End>
        <CalculatePriorToEdits>boolean</CalculatePriorToEdits>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
      </request>
    </DriverViolationsByGroup>
  </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>
    <DriverViolationsByGroupResponse xmlns="http://www.omnitracs.com">
      <DriverViolationsByGroupResult>
        <Group>string</Group>
        <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>
        <DriverCount>int</DriverCount>
        <Violations>
          <DriverViolationsByGroupData>
            <DriverId>string</DriverId>
            <TimeZone>string</TimeZone>
            <RestBreakViolations>int</RestBreakViolations>
            <DrivingViolations>int</DrivingViolations>
            <OnDutyViolations>int</OnDutyViolations>
            <CumulativeOnDutyViolations>int</CumulativeOnDutyViolations>
            <ShiftViolations>int</ShiftViolations>
            <DayOffViolations>int</DayOffViolations>
            <PassengerRuleViolations>int</PassengerRuleViolations>
            <DailyOffViolations>int</DailyOffViolations>
            <DailyOffTwoHourViolations>int</DailyOffTwoHourViolations>
            <DeferralDrivingViolations>int</DeferralDrivingViolations>
            <TotalOffDutyForDeferralViolations>int</TotalOffDutyForDeferralViolations>
            <DeferralDay1OffDutyViolations>int</DeferralDay1OffDutyViolations>
            <DeferralDay2OffDutyViolations>int</DeferralDay2OffDutyViolations>
            <RestBreakAfterExemptionViolations>int</RestBreakAfterExemptionViolations>
            <Violations xsi:nil="true" />
          </DriverViolationsByGroupData>
          <DriverViolationsByGroupData>
            <DriverId>string</DriverId>
            <TimeZone>string</TimeZone>
            <RestBreakViolations>int</RestBreakViolations>
            <DrivingViolations>int</DrivingViolations>
            <OnDutyViolations>int</OnDutyViolations>
            <CumulativeOnDutyViolations>int</CumulativeOnDutyViolations>
            <ShiftViolations>int</ShiftViolations>
            <DayOffViolations>int</DayOffViolations>
            <PassengerRuleViolations>int</PassengerRuleViolations>
            <DailyOffViolations>int</DailyOffViolations>
            <DailyOffTwoHourViolations>int</DailyOffTwoHourViolations>
            <DeferralDrivingViolations>int</DeferralDrivingViolations>
            <TotalOffDutyForDeferralViolations>int</TotalOffDutyForDeferralViolations>
            <DeferralDay1OffDutyViolations>int</DeferralDay1OffDutyViolations>
            <DeferralDay2OffDutyViolations>int</DeferralDay2OffDutyViolations>
            <RestBreakAfterExemptionViolations>int</RestBreakAfterExemptionViolations>
            <Violations xsi:nil="true" />
          </DriverViolationsByGroupData>
        </Violations>
      </DriverViolationsByGroupResult>
    </DriverViolationsByGroupResponse>
  </soap12:Body>
</soap12:Envelope>