OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

GetHOSDrivers

Get all drivers including HOS information belonging to the specified fleet (ownerID)

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 /onlineavl/api/V2.7/service.asmx HTTP/1.1
Host: onlineavl2api-us.navmanwireless.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://onlineavl2.navmanwireless.com/0907/GetHOSDrivers"

<?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>
    <GetHOSDrivers xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
      </request>
    </GetHOSDrivers>
  </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>
    <GetHOSDriversResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetHOSDriversResult>
        <OperationStatus>boolean</OperationStatus>
        <StatusMessage>
          <SystemMessage>
            <MessageCode>int</MessageCode>
            <ExceptionMessage>string</ExceptionMessage>
            <ExceptionStackTrace>string</ExceptionStackTrace>
            <ExceptionType>string</ExceptionType>
          </SystemMessage>
          <SystemMessage>
            <MessageCode>int</MessageCode>
            <ExceptionMessage>string</ExceptionMessage>
            <ExceptionStackTrace>string</ExceptionStackTrace>
            <ExceptionType>string</ExceptionType>
          </SystemMessage>
        </StatusMessage>
        <MoreItemsAvailable>boolean</MoreItemsAvailable>
        <RemovedItems>
          <guid>guid</guid>
          <guid>guid</guid>
        </RemovedItems>
        <Version>long</Version>
        <Drivers>
          <HOSDriver>
            <DriverFullName>string</DriverFullName>
            <DriverID>guid</DriverID>
            <DallasKeyID>guid</DallasKeyID>
            <DriverGroupID>guid</DriverGroupID>
            <DriverGroupName>string</DriverGroupName>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <DriverPIN>string</DriverPIN>
            <MultipleLoginsAllowed>boolean</MultipleLoginsAllowed>
            <MobilePhone>string</MobilePhone>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <Email>string</Email>
            <UniqueDriverNumber>string</UniqueDriverNumber>
            <UserLicenseAuthorization>boolean</UserLicenseAuthorization>
            <UserID>guid</UserID>
            <HOSPinID>string</HOSPinID>
            <LicenseNumber>string</LicenseNumber>
            <LicenseClass>string</LicenseClass>
            <RegID>guid</RegID>
            <RegTypeUID>guid</RegTypeUID>
            <TzUID>guid</TzUID>
            <LicenseState>string</LicenseState>
            <ExpiryDate>dateTime</ExpiryDate>
            <LastPhysical>dateTime</LastPhysical>
            <MaxDayID>guid</MaxDayID>
            <TerminalID>int</TerminalID>
            <CarrierID>guid</CarrierID>
            <CarrierName>string</CarrierName>
            <StreetAddress>string</StreetAddress>
            <StreetAddress2>string</StreetAddress2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
            <DotNumber>string</DotNumber>
          </HOSDriver>
          <HOSDriver>
            <DriverFullName>string</DriverFullName>
            <DriverID>guid</DriverID>
            <DallasKeyID>guid</DallasKeyID>
            <DriverGroupID>guid</DriverGroupID>
            <DriverGroupName>string</DriverGroupName>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <DriverPIN>string</DriverPIN>
            <MultipleLoginsAllowed>boolean</MultipleLoginsAllowed>
            <MobilePhone>string</MobilePhone>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <Email>string</Email>
            <UniqueDriverNumber>string</UniqueDriverNumber>
            <UserLicenseAuthorization>boolean</UserLicenseAuthorization>
            <UserID>guid</UserID>
            <HOSPinID>string</HOSPinID>
            <LicenseNumber>string</LicenseNumber>
            <LicenseClass>string</LicenseClass>
            <RegID>guid</RegID>
            <RegTypeUID>guid</RegTypeUID>
            <TzUID>guid</TzUID>
            <LicenseState>string</LicenseState>
            <ExpiryDate>dateTime</ExpiryDate>
            <LastPhysical>dateTime</LastPhysical>
            <MaxDayID>guid</MaxDayID>
            <TerminalID>int</TerminalID>
            <CarrierID>guid</CarrierID>
            <CarrierName>string</CarrierName>
            <StreetAddress>string</StreetAddress>
            <StreetAddress2>string</StreetAddress2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
            <DotNumber>string</DotNumber>
          </HOSDriver>
        </Drivers>
      </GetHOSDriversResult>
    </GetHOSDriversResponse>
  </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 /onlineavl/api/V2.7/service.asmx HTTP/1.1
Host: onlineavl2api-us.navmanwireless.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>
    <GetHOSDrivers xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
      </request>
    </GetHOSDrivers>
  </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>
    <GetHOSDriversResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetHOSDriversResult>
        <OperationStatus>boolean</OperationStatus>
        <StatusMessage>
          <SystemMessage>
            <MessageCode>int</MessageCode>
            <ExceptionMessage>string</ExceptionMessage>
            <ExceptionStackTrace>string</ExceptionStackTrace>
            <ExceptionType>string</ExceptionType>
          </SystemMessage>
          <SystemMessage>
            <MessageCode>int</MessageCode>
            <ExceptionMessage>string</ExceptionMessage>
            <ExceptionStackTrace>string</ExceptionStackTrace>
            <ExceptionType>string</ExceptionType>
          </SystemMessage>
        </StatusMessage>
        <MoreItemsAvailable>boolean</MoreItemsAvailable>
        <RemovedItems>
          <guid>guid</guid>
          <guid>guid</guid>
        </RemovedItems>
        <Version>long</Version>
        <Drivers>
          <HOSDriver>
            <DriverFullName>string</DriverFullName>
            <DriverID>guid</DriverID>
            <DallasKeyID>guid</DallasKeyID>
            <DriverGroupID>guid</DriverGroupID>
            <DriverGroupName>string</DriverGroupName>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <DriverPIN>string</DriverPIN>
            <MultipleLoginsAllowed>boolean</MultipleLoginsAllowed>
            <MobilePhone>string</MobilePhone>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <Email>string</Email>
            <UniqueDriverNumber>string</UniqueDriverNumber>
            <UserLicenseAuthorization>boolean</UserLicenseAuthorization>
            <UserID>guid</UserID>
            <HOSPinID>string</HOSPinID>
            <LicenseNumber>string</LicenseNumber>
            <LicenseClass>string</LicenseClass>
            <RegID>guid</RegID>
            <RegTypeUID>guid</RegTypeUID>
            <TzUID>guid</TzUID>
            <LicenseState>string</LicenseState>
            <ExpiryDate>dateTime</ExpiryDate>
            <LastPhysical>dateTime</LastPhysical>
            <MaxDayID>guid</MaxDayID>
            <TerminalID>int</TerminalID>
            <CarrierID>guid</CarrierID>
            <CarrierName>string</CarrierName>
            <StreetAddress>string</StreetAddress>
            <StreetAddress2>string</StreetAddress2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
            <DotNumber>string</DotNumber>
          </HOSDriver>
          <HOSDriver>
            <DriverFullName>string</DriverFullName>
            <DriverID>guid</DriverID>
            <DallasKeyID>guid</DallasKeyID>
            <DriverGroupID>guid</DriverGroupID>
            <DriverGroupName>string</DriverGroupName>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <DriverPIN>string</DriverPIN>
            <MultipleLoginsAllowed>boolean</MultipleLoginsAllowed>
            <MobilePhone>string</MobilePhone>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <Email>string</Email>
            <UniqueDriverNumber>string</UniqueDriverNumber>
            <UserLicenseAuthorization>boolean</UserLicenseAuthorization>
            <UserID>guid</UserID>
            <HOSPinID>string</HOSPinID>
            <LicenseNumber>string</LicenseNumber>
            <LicenseClass>string</LicenseClass>
            <RegID>guid</RegID>
            <RegTypeUID>guid</RegTypeUID>
            <TzUID>guid</TzUID>
            <LicenseState>string</LicenseState>
            <ExpiryDate>dateTime</ExpiryDate>
            <LastPhysical>dateTime</LastPhysical>
            <MaxDayID>guid</MaxDayID>
            <TerminalID>int</TerminalID>
            <CarrierID>guid</CarrierID>
            <CarrierName>string</CarrierName>
            <StreetAddress>string</StreetAddress>
            <StreetAddress2>string</StreetAddress2>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Country>string</Country>
            <DotNumber>string</DotNumber>
          </HOSDriver>
        </Drivers>
      </GetHOSDriversResult>
    </GetHOSDriversResponse>
  </soap12:Body>
</soap12:Envelope>