Driver


Click here for a complete list of operations.

ClockInOut

This web service allows customers to clock a driver in or out.

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

<?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>
    <ClockInOut xmlns="http://www.omnitracs.com">
      <clockInOutRequest>
        <DriverID>string</DriverID>
        <State>string</State>
        <City>string</City>
        <Action>ClockIn or ClockOut</Action>
        <EffectiveTime>dateTime</EffectiveTime>
      </clockInOutRequest>
    </ClockInOut>
  </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>
    <ClockInOutResponse xmlns="http://www.omnitracs.com">
      <ClockInOutResult>
        <DriverID>string</DriverID>
        <City>string</City>
        <State>string</State>
        <ClockInAction>ClockIn or ClockOut</ClockInAction>
        <EventTime>dateTime</EventTime>
        <ResponseCode>Success_ClockIn or Successive_ClockIn or Success_ClockOut or Successive_ClockOut or Success_ClockOut_No_Change_Previous_OffDuty or Success_ClockOut_W_Change_Previous_OffDuty</ResponseCode>
        <Value>string</Value>
      </ClockInOutResult>
    </ClockInOutResponse>
  </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>
    <ClockInOut xmlns="http://www.omnitracs.com">
      <clockInOutRequest>
        <DriverID>string</DriverID>
        <State>string</State>
        <City>string</City>
        <Action>ClockIn or ClockOut</Action>
        <EffectiveTime>dateTime</EffectiveTime>
      </clockInOutRequest>
    </ClockInOut>
  </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>
    <ClockInOutResponse xmlns="http://www.omnitracs.com">
      <ClockInOutResult>
        <DriverID>string</DriverID>
        <City>string</City>
        <State>string</State>
        <ClockInAction>ClockIn or ClockOut</ClockInAction>
        <EventTime>dateTime</EventTime>
        <ResponseCode>Success_ClockIn or Successive_ClockIn or Success_ClockOut or Successive_ClockOut or Success_ClockOut_No_Change_Previous_OffDuty or Success_ClockOut_W_Change_Previous_OffDuty</ResponseCode>
        <Value>string</Value>
      </ClockInOutResult>
    </ClockInOutResponse>
  </soap12:Body>
</soap12:Envelope>