Driver Web Service

Driver

Click here for a complete list of operations.

DriverLogQueueByGroupEx

Returns driver log records for specified driver group. A maximum of 1,000 records will be returned each call. Provide Start date and time (yyyy-mm-ddThh:mm:ss) only for the first call or omit on first call for the start of the current day (midnight Eastern time zone) and set LogId=0 to retrieve from the first record of the day. Afterwards, use only the NextLogId returned in the previous call as Start will be ignored. When no more records are available, NextLogId will point to the next future duty log entry. If no records are returned at all, NextLogId will contain the value of the LogId input parameter used in the call which can therefore be re-used in the next call. Providing an End date and time is optional. To retrieve records for all drivers, use the group, '- All -' (dash, space, All, space, dash with no quotes). All times are in GMT if LocalTime parameter is set to false. Otherwise the Start and End times are assumed to be in Eastern time zone. The StartTime of each record is in its depot local time for the assigned driver if the LocalTime parameter is set to true. Since records may be in many different time zones, the specific time zone is returned for each record. Odometers and DistanceDriven are in tenths of miles. When a record indicates it is marked as a Correction to a previous record, the OriginalLogId field contains the LogId of the original record to facilitate the matching of Corrections to Originals. If the record is marked as Original, then the OriginalLogId field will point to the LogId of the new, corrected record. If an edit is undone, a new LogId will be assigned to the original record while the correction will be deleted.

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

<?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>
    <DriverLogQueueByGroupEx xmlns="http://www.omnitracs.com">
      <request>
        <DriverGroup>string</DriverGroup>
        <Start>dateTime</Start>
        <End>dateTime</End>
        <LocalTime>boolean</LocalTime>
        <LogId>int</LogId>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
      </request>
    </DriverLogQueueByGroupEx>
  </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>
    <DriverLogQueueByGroupExResponse xmlns="http://www.omnitracs.com">
      <DriverLogQueueByGroupExResult>
        <DriverGroup>string</DriverGroup>
        <RecordsReturned>int</RecordsReturned>
        <Logs>
          <DriverLogQueueDataEx>
            <DriverId>string</DriverId>
            <TractorId>string</TractorId>
            <Activity>Unknown or OffDuty or Sleeper or Driving or OnDuty or OffDutyDriving or PersonalConveyance or YardMove</Activity>
            <WaitingInOilWell>boolean</WaitingInOilWell>
            <HazmatOnDutyRest>boolean</HazmatOnDutyRest>
            <StartTime>dateTime</StartTime>
            <Duration>int</Duration>
            <Edit>None or Original or Correction</Edit>
            <State>string</State>
            <Odometer>int</Odometer>
            <DistanceDriven>int</DistanceDriven>
            <CoDriverId>string</CoDriverId>
            <Location>string</Location>
            <Document>string</Document>
            <TrailerId>string</TrailerId>
            <Confirmed>boolean</Confirmed>
            <SensorFailure>boolean</SensorFailure>
            <TimeZone>string</TimeZone>
            <Remark2>string</Remark2>
            <Remark1>string</Remark1>
            <EditReason>string</EditReason>
            <OriginalLogId>int</OriginalLogId>
            <LogId>int</LogId>
          </DriverLogQueueDataEx>
          <DriverLogQueueDataEx>
            <DriverId>string</DriverId>
            <TractorId>string</TractorId>
            <Activity>Unknown or OffDuty or Sleeper or Driving or OnDuty or OffDutyDriving or PersonalConveyance or YardMove</Activity>
            <WaitingInOilWell>boolean</WaitingInOilWell>
            <HazmatOnDutyRest>boolean</HazmatOnDutyRest>
            <StartTime>dateTime</StartTime>
            <Duration>int</Duration>
            <Edit>None or Original or Correction</Edit>
            <State>string</State>
            <Odometer>int</Odometer>
            <DistanceDriven>int</DistanceDriven>
            <CoDriverId>string</CoDriverId>
            <Location>string</Location>
            <Document>string</Document>
            <TrailerId>string</TrailerId>
            <Confirmed>boolean</Confirmed>
            <SensorFailure>boolean</SensorFailure>
            <TimeZone>string</TimeZone>
            <Remark2>string</Remark2>
            <Remark1>string</Remark1>
            <EditReason>string</EditReason>
            <OriginalLogId>int</OriginalLogId>
            <LogId>int</LogId>
          </DriverLogQueueDataEx>
        </Logs>
        <NextLogId>int</NextLogId>
      </DriverLogQueueByGroupExResult>
    </DriverLogQueueByGroupExResponse>
  </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>
    <DriverLogQueueByGroupEx xmlns="http://www.omnitracs.com">
      <request>
        <DriverGroup>string</DriverGroup>
        <Start>dateTime</Start>
        <End>dateTime</End>
        <LocalTime>boolean</LocalTime>
        <LogId>int</LogId>
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>
      </request>
    </DriverLogQueueByGroupEx>
  </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>
    <DriverLogQueueByGroupExResponse xmlns="http://www.omnitracs.com">
      <DriverLogQueueByGroupExResult>
        <DriverGroup>string</DriverGroup>
        <RecordsReturned>int</RecordsReturned>
        <Logs>
          <DriverLogQueueDataEx>
            <DriverId>string</DriverId>
            <TractorId>string</TractorId>
            <Activity>Unknown or OffDuty or Sleeper or Driving or OnDuty or OffDutyDriving or PersonalConveyance or YardMove</Activity>
            <WaitingInOilWell>boolean</WaitingInOilWell>
            <HazmatOnDutyRest>boolean</HazmatOnDutyRest>
            <StartTime>dateTime</StartTime>
            <Duration>int</Duration>
            <Edit>None or Original or Correction</Edit>
            <State>string</State>
            <Odometer>int</Odometer>
            <DistanceDriven>int</DistanceDriven>
            <CoDriverId>string</CoDriverId>
            <Location>string</Location>
            <Document>string</Document>
            <TrailerId>string</TrailerId>
            <Confirmed>boolean</Confirmed>
            <SensorFailure>boolean</SensorFailure>
            <TimeZone>string</TimeZone>
            <Remark2>string</Remark2>
            <Remark1>string</Remark1>
            <EditReason>string</EditReason>
            <OriginalLogId>int</OriginalLogId>
            <LogId>int</LogId>
          </DriverLogQueueDataEx>
          <DriverLogQueueDataEx>
            <DriverId>string</DriverId>
            <TractorId>string</TractorId>
            <Activity>Unknown or OffDuty or Sleeper or Driving or OnDuty or OffDutyDriving or PersonalConveyance or YardMove</Activity>
            <WaitingInOilWell>boolean</WaitingInOilWell>
            <HazmatOnDutyRest>boolean</HazmatOnDutyRest>
            <StartTime>dateTime</StartTime>
            <Duration>int</Duration>
            <Edit>None or Original or Correction</Edit>
            <State>string</State>
            <Odometer>int</Odometer>
            <DistanceDriven>int</DistanceDriven>
            <CoDriverId>string</CoDriverId>
            <Location>string</Location>
            <Document>string</Document>
            <TrailerId>string</TrailerId>
            <Confirmed>boolean</Confirmed>
            <SensorFailure>boolean</SensorFailure>
            <TimeZone>string</TimeZone>
            <Remark2>string</Remark2>
            <Remark1>string</Remark1>
            <EditReason>string</EditReason>
            <OriginalLogId>int</OriginalLogId>
            <LogId>int</LogId>
          </DriverLogQueueDataEx>
        </Logs>
        <NextLogId>int</NextLogId>
      </DriverLogQueueByGroupExResult>
    </DriverLogQueueByGroupExResponse>
  </soap12:Body>
</soap12:Envelope>