OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

GetFormList

Gets a list of form definitions

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/V1.3/service.asmx HTTP/1.1
Host: onlineavl2api-mx.navmanwireless.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://onlineavl2.navmanwireless.com/0907/GetFormList"

<?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>
    <GetFormList xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
      </request>
    </GetFormList>
  </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>
    <GetFormListResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetFormListResult>
        <OperationStatus>boolean</OperationStatus>
        <StatusMessages>
          <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>
        </StatusMessages>
        <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>
        <FormSummaryItemList>
          <FormSummaryItem>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <Name>string</Name>
            <Description>string</Description>
            <CanBeSentBy>undefined or dispatcher or driver or both</CanBeSentBy>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
          </FormSummaryItem>
          <FormSummaryItem>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <Name>string</Name>
            <Description>string</Description>
            <CanBeSentBy>undefined or dispatcher or driver or both</CanBeSentBy>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
          </FormSummaryItem>
        </FormSummaryItemList>
      </GetFormListResult>
    </GetFormListResponse>
  </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/V1.3/service.asmx HTTP/1.1
Host: onlineavl2api-mx.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>
    <GetFormList xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
      </request>
    </GetFormList>
  </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>
    <GetFormListResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetFormListResult>
        <OperationStatus>boolean</OperationStatus>
        <StatusMessages>
          <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>
        </StatusMessages>
        <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>
        <FormSummaryItemList>
          <FormSummaryItem>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <Name>string</Name>
            <Description>string</Description>
            <CanBeSentBy>undefined or dispatcher or driver or both</CanBeSentBy>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
          </FormSummaryItem>
          <FormSummaryItem>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <Name>string</Name>
            <Description>string</Description>
            <CanBeSentBy>undefined or dispatcher or driver or both</CanBeSentBy>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
          </FormSummaryItem>
        </FormSummaryItemList>
      </GetFormListResult>
    </GetFormListResponse>
  </soap12:Body>
</soap12:Envelope>