Driver Web Service

Driver

Click here for a complete list of operations.

UpdateDriver

Update Driver data. Client is not allowed to change card ID or NMC Account #. If driver data was already stored, use stored values for omitted fields.
Valid values for DefaultRuleSet, USDefaultDutyCycle, and CANDefaultDutyCycle enumerator fields are listed in Update method.

Return value true indicates that the data was persisted successfully. SOAP Fault indicates failure to update.

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

<?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>
    <UpdateDriver xmlns="http://www.omnitracs.com">
      <updateParams>
        <Driver>
          <DriverId>string</DriverId>
          <UpdateDriverId>string</UpdateDriverId>
          <Password>string</Password>
          <LastName>string</LastName>
          <FirstName>string</FirstName>
          <DepotId>string</DepotId>
          <DriverGroup>
            <string>string</string>
            <string>string</string>
          </DriverGroup>
          <DefaultRuleSet>string</DefaultRuleSet>
          <USDefaultDutyCycle>string</USDefaultDutyCycle>
          <CANDefaultDutyCycle>string</CANDefaultDutyCycle>
        </Driver>
      </updateParams>
    </UpdateDriver>
  </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>
    <UpdateDriverResponse xmlns="http://www.omnitracs.com">
      <UpdateDriverResult>
        <IsUpdated>boolean</IsUpdated>
      </UpdateDriverResult>
    </UpdateDriverResponse>
  </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>
    <UpdateDriver xmlns="http://www.omnitracs.com">
      <updateParams>
        <Driver>
          <DriverId>string</DriverId>
          <UpdateDriverId>string</UpdateDriverId>
          <Password>string</Password>
          <LastName>string</LastName>
          <FirstName>string</FirstName>
          <DepotId>string</DepotId>
          <DriverGroup>
            <string>string</string>
            <string>string</string>
          </DriverGroup>
          <DefaultRuleSet>string</DefaultRuleSet>
          <USDefaultDutyCycle>string</USDefaultDutyCycle>
          <CANDefaultDutyCycle>string</CANDefaultDutyCycle>
        </Driver>
      </updateParams>
    </UpdateDriver>
  </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>
    <UpdateDriverResponse xmlns="http://www.omnitracs.com">
      <UpdateDriverResult>
        <IsUpdated>boolean</IsUpdated>
      </UpdateDriverResult>
    </UpdateDriverResponse>
  </soap12:Body>
</soap12:Envelope>