Driver Web Service

Driver

Click here for a complete list of operations.

AddEx

Adds the Driver data provided to the HOS database. In addition to all the parameters accepted by the Add function this takes the extra paramter InOffDutyDrvPolicy which is a enum with values Allowed or NotAllowed and adds it to the HOS database.

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

<?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>
    <AddEx xmlns="http://www.omnitracs.com">
      <addParams>
        <Drivers>
          <DriverDataEx>
            <DriverId>string</DriverId>
            <DriverPortalPin>string</DriverPortalPin>
            <UpdateDriverId>string</UpdateDriverId>
            <Password>string</Password>
            <LastName>string</LastName>
            <FirstName>string</FirstName>
            <DepotId>short</DepotId>
            <DriverGroup xsi:nil="true" />
            <InOffDutyDrvPolicy>NotAllowed or Allowed</InOffDutyDrvPolicy>
            <WaitingInOilWell>None or NotAllowed or Allowed</WaitingInOilWell>
            <TwentyFourHrReset>None or NotAllowed or Allowed</TwentyFourHrReset>
            <HazmatLoadHauler>None or NotAllowed or Allowed</HazmatLoadHauler>
            <EnableCanadianRules>None or NotAllowed or Allowed</EnableCanadianRules>
            <DefaultRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</DefaultRuleSet>
            <USDefaultDutyCycle>None or SevenDay or EightDay</USDefaultDutyCycle>
            <CANDefaultDutyCycle>None or SevenDay or FourteenDay</CANDefaultDutyCycle>
            <EnableRestBreakExemption>None or NotAllowed or Allowed</EnableRestBreakExemption>
            <EnableSixteenHourExemption>None or NotAllowed or Allowed</EnableSixteenHourExemption>
            <ELDExempt>boolean</ELDExempt>
            <ELDExemptReason>string</ELDExemptReason>
            <CDL>string</CDL>
            <CDLState>None or Alabama or Alaska or Arkansas or Arizona or California or Colorado or Connecticut or DistrictOfColumbia or Delaware or Florida or Georgia or Hawaii or Iowa or Idaho or Illinois or Indiana or Kansas or Kentucky or Louisiana or Massachusetts or Maryland or Maine or Michigan or Minnesota or Missouri or Mississippi or Montana or NorthCarolina or NorthDakota or Nebraska or NewHampshire or NewJersey or NewMexico or Nevada or NewYork or Ohio or Oklahoma or Oregon or Pennsylvania or RhodeIsland or SouthCarolina or SouthDakota or Tennessee or Texas or Utah or Virginia or Vermont or Washington or Wisconsin or WestVirginia or Wyoming or AmericanSamoa or Guam or NorthernMarianas or PuertoRico or VirginIslands or Alberta or BritishColumbia or Manitoba or NewBrunswick or Newfoundland or NovaScotia or NorthwestTerritories or Ontario or PrinceEdwardIsland or Quebec or Saskatchewan or YukonTerritory or Aguascalientes or BajaCaliforniaNorte or BajaCaliforniaSur or Coahuila or Chihuahua or Colima or Campeche or Chiapas or DistritoFederal or Durango or Guerrero or Guanajuato or Hidalgo or Jalisco or Michoacan or Morelos or Mexico or Nayarit or NuevoLeon or Oaxaca or Puebla or Queretaro or QuintanaRoo or Sinaloa or SanLuisPotosi or Sonora or Tamaulipas or Tabasco or Tlaxcala or Veracruz or Yucatan or Zacatecas or Other or Clear</CDLState>
            <EnableYardMove>None or NotAllowed or Allowed</EnableYardMove>
          </DriverDataEx>
          <DriverDataEx>
            <DriverId>string</DriverId>
            <DriverPortalPin>string</DriverPortalPin>
            <UpdateDriverId>string</UpdateDriverId>
            <Password>string</Password>
            <LastName>string</LastName>
            <FirstName>string</FirstName>
            <DepotId>short</DepotId>
            <DriverGroup xsi:nil="true" />
            <InOffDutyDrvPolicy>NotAllowed or Allowed</InOffDutyDrvPolicy>
            <WaitingInOilWell>None or NotAllowed or Allowed</WaitingInOilWell>
            <TwentyFourHrReset>None or NotAllowed or Allowed</TwentyFourHrReset>
            <HazmatLoadHauler>None or NotAllowed or Allowed</HazmatLoadHauler>
            <EnableCanadianRules>None or NotAllowed or Allowed</EnableCanadianRules>
            <DefaultRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</DefaultRuleSet>
            <USDefaultDutyCycle>None or SevenDay or EightDay</USDefaultDutyCycle>
            <CANDefaultDutyCycle>None or SevenDay or FourteenDay</CANDefaultDutyCycle>
            <EnableRestBreakExemption>None or NotAllowed or Allowed</EnableRestBreakExemption>
            <EnableSixteenHourExemption>None or NotAllowed or Allowed</EnableSixteenHourExemption>
            <ELDExempt>boolean</ELDExempt>
            <ELDExemptReason>string</ELDExemptReason>
            <CDL>string</CDL>
            <CDLState>None or Alabama or Alaska or Arkansas or Arizona or California or Colorado or Connecticut or DistrictOfColumbia or Delaware or Florida or Georgia or Hawaii or Iowa or Idaho or Illinois or Indiana or Kansas or Kentucky or Louisiana or Massachusetts or Maryland or Maine or Michigan or Minnesota or Missouri or Mississippi or Montana or NorthCarolina or NorthDakota or Nebraska or NewHampshire or NewJersey or NewMexico or Nevada or NewYork or Ohio or Oklahoma or Oregon or Pennsylvania or RhodeIsland or SouthCarolina or SouthDakota or Tennessee or Texas or Utah or Virginia or Vermont or Washington or Wisconsin or WestVirginia or Wyoming or AmericanSamoa or Guam or NorthernMarianas or PuertoRico or VirginIslands or Alberta or BritishColumbia or Manitoba or NewBrunswick or Newfoundland or NovaScotia or NorthwestTerritories or Ontario or PrinceEdwardIsland or Quebec or Saskatchewan or YukonTerritory or Aguascalientes or BajaCaliforniaNorte or BajaCaliforniaSur or Coahuila or Chihuahua or Colima or Campeche or Chiapas or DistritoFederal or Durango or Guerrero or Guanajuato or Hidalgo or Jalisco or Michoacan or Morelos or Mexico or Nayarit or NuevoLeon or Oaxaca or Puebla or Queretaro or QuintanaRoo or Sinaloa or SanLuisPotosi or Sonora or Tamaulipas or Tabasco or Tlaxcala or Veracruz or Yucatan or Zacatecas or Other or Clear</CDLState>
            <EnableYardMove>None or NotAllowed or Allowed</EnableYardMove>
          </DriverDataEx>
        </Drivers>
      </addParams>
    </AddEx>
  </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>
    <AddExResponse xmlns="http://www.omnitracs.com">
      <AddExResult />
    </AddExResponse>
  </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>
    <AddEx xmlns="http://www.omnitracs.com">
      <addParams>
        <Drivers>
          <DriverDataEx>
            <DriverId>string</DriverId>
            <DriverPortalPin>string</DriverPortalPin>
            <UpdateDriverId>string</UpdateDriverId>
            <Password>string</Password>
            <LastName>string</LastName>
            <FirstName>string</FirstName>
            <DepotId>short</DepotId>
            <DriverGroup xsi:nil="true" />
            <InOffDutyDrvPolicy>NotAllowed or Allowed</InOffDutyDrvPolicy>
            <WaitingInOilWell>None or NotAllowed or Allowed</WaitingInOilWell>
            <TwentyFourHrReset>None or NotAllowed or Allowed</TwentyFourHrReset>
            <HazmatLoadHauler>None or NotAllowed or Allowed</HazmatLoadHauler>
            <EnableCanadianRules>None or NotAllowed or Allowed</EnableCanadianRules>
            <DefaultRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</DefaultRuleSet>
            <USDefaultDutyCycle>None or SevenDay or EightDay</USDefaultDutyCycle>
            <CANDefaultDutyCycle>None or SevenDay or FourteenDay</CANDefaultDutyCycle>
            <EnableRestBreakExemption>None or NotAllowed or Allowed</EnableRestBreakExemption>
            <EnableSixteenHourExemption>None or NotAllowed or Allowed</EnableSixteenHourExemption>
            <ELDExempt>boolean</ELDExempt>
            <ELDExemptReason>string</ELDExemptReason>
            <CDL>string</CDL>
            <CDLState>None or Alabama or Alaska or Arkansas or Arizona or California or Colorado or Connecticut or DistrictOfColumbia or Delaware or Florida or Georgia or Hawaii or Iowa or Idaho or Illinois or Indiana or Kansas or Kentucky or Louisiana or Massachusetts or Maryland or Maine or Michigan or Minnesota or Missouri or Mississippi or Montana or NorthCarolina or NorthDakota or Nebraska or NewHampshire or NewJersey or NewMexico or Nevada or NewYork or Ohio or Oklahoma or Oregon or Pennsylvania or RhodeIsland or SouthCarolina or SouthDakota or Tennessee or Texas or Utah or Virginia or Vermont or Washington or Wisconsin or WestVirginia or Wyoming or AmericanSamoa or Guam or NorthernMarianas or PuertoRico or VirginIslands or Alberta or BritishColumbia or Manitoba or NewBrunswick or Newfoundland or NovaScotia or NorthwestTerritories or Ontario or PrinceEdwardIsland or Quebec or Saskatchewan or YukonTerritory or Aguascalientes or BajaCaliforniaNorte or BajaCaliforniaSur or Coahuila or Chihuahua or Colima or Campeche or Chiapas or DistritoFederal or Durango or Guerrero or Guanajuato or Hidalgo or Jalisco or Michoacan or Morelos or Mexico or Nayarit or NuevoLeon or Oaxaca or Puebla or Queretaro or QuintanaRoo or Sinaloa or SanLuisPotosi or Sonora or Tamaulipas or Tabasco or Tlaxcala or Veracruz or Yucatan or Zacatecas or Other or Clear</CDLState>
            <EnableYardMove>None or NotAllowed or Allowed</EnableYardMove>
          </DriverDataEx>
          <DriverDataEx>
            <DriverId>string</DriverId>
            <DriverPortalPin>string</DriverPortalPin>
            <UpdateDriverId>string</UpdateDriverId>
            <Password>string</Password>
            <LastName>string</LastName>
            <FirstName>string</FirstName>
            <DepotId>short</DepotId>
            <DriverGroup xsi:nil="true" />
            <InOffDutyDrvPolicy>NotAllowed or Allowed</InOffDutyDrvPolicy>
            <WaitingInOilWell>None or NotAllowed or Allowed</WaitingInOilWell>
            <TwentyFourHrReset>None or NotAllowed or Allowed</TwentyFourHrReset>
            <HazmatLoadHauler>None or NotAllowed or Allowed</HazmatLoadHauler>
            <EnableCanadianRules>None or NotAllowed or Allowed</EnableCanadianRules>
            <DefaultRuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</DefaultRuleSet>
            <USDefaultDutyCycle>None or SevenDay or EightDay</USDefaultDutyCycle>
            <CANDefaultDutyCycle>None or SevenDay or FourteenDay</CANDefaultDutyCycle>
            <EnableRestBreakExemption>None or NotAllowed or Allowed</EnableRestBreakExemption>
            <EnableSixteenHourExemption>None or NotAllowed or Allowed</EnableSixteenHourExemption>
            <ELDExempt>boolean</ELDExempt>
            <ELDExemptReason>string</ELDExemptReason>
            <CDL>string</CDL>
            <CDLState>None or Alabama or Alaska or Arkansas or Arizona or California or Colorado or Connecticut or DistrictOfColumbia or Delaware or Florida or Georgia or Hawaii or Iowa or Idaho or Illinois or Indiana or Kansas or Kentucky or Louisiana or Massachusetts or Maryland or Maine or Michigan or Minnesota or Missouri or Mississippi or Montana or NorthCarolina or NorthDakota or Nebraska or NewHampshire or NewJersey or NewMexico or Nevada or NewYork or Ohio or Oklahoma or Oregon or Pennsylvania or RhodeIsland or SouthCarolina or SouthDakota or Tennessee or Texas or Utah or Virginia or Vermont or Washington or Wisconsin or WestVirginia or Wyoming or AmericanSamoa or Guam or NorthernMarianas or PuertoRico or VirginIslands or Alberta or BritishColumbia or Manitoba or NewBrunswick or Newfoundland or NovaScotia or NorthwestTerritories or Ontario or PrinceEdwardIsland or Quebec or Saskatchewan or YukonTerritory or Aguascalientes or BajaCaliforniaNorte or BajaCaliforniaSur or Coahuila or Chihuahua or Colima or Campeche or Chiapas or DistritoFederal or Durango or Guerrero or Guanajuato or Hidalgo or Jalisco or Michoacan or Morelos or Mexico or Nayarit or NuevoLeon or Oaxaca or Puebla or Queretaro or QuintanaRoo or Sinaloa or SanLuisPotosi or Sonora or Tamaulipas or Tabasco or Tlaxcala or Veracruz or Yucatan or Zacatecas or Other or Clear</CDLState>
            <EnableYardMove>None or NotAllowed or Allowed</EnableYardMove>
          </DriverDataEx>
        </Drivers>
      </addParams>
    </AddEx>
  </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>
    <AddExResponse xmlns="http://www.omnitracs.com">
      <AddExResult />
    </AddExResponse>
  </soap12:Body>
</soap12:Envelope>