OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

AddDriverByType

Add driver with specified details to the indicated fleet.

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

<?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>
    <AddDriverByType xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <OwnerID>guid</OwnerID>
        <RequestType>_DRIVER_REQUEST_BASIC or _DRIVER_REQUEST_HOS or _DRIVER_REQUEST_DRIVERID</RequestType>
        <Title>string</Title>
        <FirstName>string</FirstName>
        <Surname>string</Surname>
        <IsCredentialsActive>boolean</IsCredentialsActive>
        <CredentialsExpiryDateTime>dateTime</CredentialsExpiryDateTime>
        <DriverPin>string</DriverPin>
        <HoSPinID>string</HoSPinID>
        <DallasKeyID>string</DallasKeyID>
        <DriverGroupID>guid</DriverGroupID>
        <MultipleLoginsAllowed>boolean</MultipleLoginsAllowed>
        <MobilePhone>string</MobilePhone>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <Address4>string</Address4>
        <Email>string</Email>
        <UniqueDriverNumber>string</UniqueDriverNumber>
        <UseLicenceAuthorization>boolean</UseLicenceAuthorization>
        <LicenceNumber>string</LicenceNumber>
        <LicenceClassID>guid</LicenceClassID>
        <ExpiryDate>dateTime</ExpiryDate>
        <LicenceState>string</LicenceState>
        <LastPhysical>dateTime</LastPhysical>
        <DriverPortalUserID>string</DriverPortalUserID>
        <RegulationID>guid</RegulationID>
        <MaxDayID>guid</MaxDayID>
        <TimezoneID>guid</TimezoneID>
        <TerminalID>int</TerminalID>
      </request>
    </AddDriverByType>
  </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>
    <AddDriverByTypeResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <AddDriverByTypeResult>
        <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>
      </AddDriverByTypeResult>
    </AddDriverByTypeResponse>
  </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>
    <AddDriverByType xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <OwnerID>guid</OwnerID>
        <RequestType>_DRIVER_REQUEST_BASIC or _DRIVER_REQUEST_HOS or _DRIVER_REQUEST_DRIVERID</RequestType>
        <Title>string</Title>
        <FirstName>string</FirstName>
        <Surname>string</Surname>
        <IsCredentialsActive>boolean</IsCredentialsActive>
        <CredentialsExpiryDateTime>dateTime</CredentialsExpiryDateTime>
        <DriverPin>string</DriverPin>
        <HoSPinID>string</HoSPinID>
        <DallasKeyID>string</DallasKeyID>
        <DriverGroupID>guid</DriverGroupID>
        <MultipleLoginsAllowed>boolean</MultipleLoginsAllowed>
        <MobilePhone>string</MobilePhone>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <Address4>string</Address4>
        <Email>string</Email>
        <UniqueDriverNumber>string</UniqueDriverNumber>
        <UseLicenceAuthorization>boolean</UseLicenceAuthorization>
        <LicenceNumber>string</LicenceNumber>
        <LicenceClassID>guid</LicenceClassID>
        <ExpiryDate>dateTime</ExpiryDate>
        <LicenceState>string</LicenceState>
        <LastPhysical>dateTime</LastPhysical>
        <DriverPortalUserID>string</DriverPortalUserID>
        <RegulationID>guid</RegulationID>
        <MaxDayID>guid</MaxDayID>
        <TimezoneID>guid</TimezoneID>
        <TerminalID>int</TerminalID>
      </request>
    </AddDriverByType>
  </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>
    <AddDriverByTypeResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <AddDriverByTypeResult>
        <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>
      </AddDriverByTypeResult>
    </AddDriverByTypeResponse>
  </soap12:Body>
</soap12:Envelope>