Driver


Click here for a complete list of operations.

GetViolationEvents

Returns the Warning and Violation events for all the drivers of the company upto a maximum of 1000.For the first invocation set Event Id to 0 and specify a start time. For subsequent invocations pass in the Event Id that was provided as in the result of previous invocation of this web service.

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

<?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>
    <GetViolationEvents xmlns="http://www.omnitracs.com">
      <ViolationEventsParams>
        <EventId>long</EventId>
        <StartTime>dateTime</StartTime>
      </ViolationEventsParams>
    </GetViolationEvents>
  </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>
    <GetViolationEventsResponse xmlns="http://www.omnitracs.com">
      <GetViolationEventsResult>
        <ViolationEventList>
          <ViolationEvent>
            <DriverId>string</DriverId>
            <DepotId>int</DepotId>
            <EventType>NO_WARNING_VIOLATION or THIRTY_MINUTE_WARNING or SIXTY_MINUTE_WARNING or VIOLATION</EventType>
            <Clock>None or Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or WorkLeft</Clock>
            <EventTime>dateTime</EventTime>
            <CalculationTime>dateTime</CalculationTime>
            <MinutesLeftToDrive>int</MinutesLeftToDrive>
          </ViolationEvent>
          <ViolationEvent>
            <DriverId>string</DriverId>
            <DepotId>int</DepotId>
            <EventType>NO_WARNING_VIOLATION or THIRTY_MINUTE_WARNING or SIXTY_MINUTE_WARNING or VIOLATION</EventType>
            <Clock>None or Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or WorkLeft</Clock>
            <EventTime>dateTime</EventTime>
            <CalculationTime>dateTime</CalculationTime>
            <MinutesLeftToDrive>int</MinutesLeftToDrive>
          </ViolationEvent>
        </ViolationEventList>
        <NextEventId>long</NextEventId>
      </GetViolationEventsResult>
    </GetViolationEventsResponse>
  </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>
    <GetViolationEvents xmlns="http://www.omnitracs.com">
      <ViolationEventsParams>
        <EventId>long</EventId>
        <StartTime>dateTime</StartTime>
      </ViolationEventsParams>
    </GetViolationEvents>
  </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>
    <GetViolationEventsResponse xmlns="http://www.omnitracs.com">
      <GetViolationEventsResult>
        <ViolationEventList>
          <ViolationEvent>
            <DriverId>string</DriverId>
            <DepotId>int</DepotId>
            <EventType>NO_WARNING_VIOLATION or THIRTY_MINUTE_WARNING or SIXTY_MINUTE_WARNING or VIOLATION</EventType>
            <Clock>None or Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or WorkLeft</Clock>
            <EventTime>dateTime</EventTime>
            <CalculationTime>dateTime</CalculationTime>
            <MinutesLeftToDrive>int</MinutesLeftToDrive>
          </ViolationEvent>
          <ViolationEvent>
            <DriverId>string</DriverId>
            <DepotId>int</DepotId>
            <EventType>NO_WARNING_VIOLATION or THIRTY_MINUTE_WARNING or SIXTY_MINUTE_WARNING or VIOLATION</EventType>
            <Clock>None or Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or WorkLeft</Clock>
            <EventTime>dateTime</EventTime>
            <CalculationTime>dateTime</CalculationTime>
            <MinutesLeftToDrive>int</MinutesLeftToDrive>
          </ViolationEvent>
        </ViolationEventList>
        <NextEventId>long</NextEventId>
      </GetViolationEventsResult>
    </GetViolationEventsResponse>
  </soap12:Body>
</soap12:Envelope>