OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

GetSendRouteMessagesStatus

This method provides a mechanism for the client application to request a status update for the batch route-to messages request which was sent to the server using the DoSendRouteMessages() web service method.

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

<?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>
    <GetSendRouteMessagesStatus xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <OperationStatusGuid>guid</OperationStatusGuid>
      </request>
    </GetSendRouteMessagesStatus>
  </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>
    <GetSendRouteMessagesStatusResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetSendRouteMessagesStatusResult>
        <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>
        <BatchProcessRunning>boolean</BatchProcessRunning>
        <OperationState>NotStarted or Started or InProgress or Completed</OperationState>
        <OperationStatusGuid>guid</OperationStatusGuid>
        <BatchOperationStartTime>dateTime</BatchOperationStartTime>
        <BatchOperationEndTime>dateTime</BatchOperationEndTime>
        <RequestedOperationsCount>int</RequestedOperationsCount>
        <OperationsProcessed>int</OperationsProcessed>
        <SuccessfulOperationsCount>int</SuccessfulOperationsCount>
        <FailedOperationsCount>int</FailedOperationsCount>
        <DoSendRouteMessageResponses>
          <DoSendRouteMessageResponse>
            <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>
            <VehicleIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </VehicleIds>
            <MessageIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </MessageIds>
            <RecordId>int</RecordId>
          </DoSendRouteMessageResponse>
          <DoSendRouteMessageResponse>
            <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>
            <VehicleIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </VehicleIds>
            <MessageIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </MessageIds>
            <RecordId>int</RecordId>
          </DoSendRouteMessageResponse>
        </DoSendRouteMessageResponses>
        <WebServerName>string</WebServerName>
        <BatchProcessId>int</BatchProcessId>
        <StatusUpdateTime>dateTime</StatusUpdateTime>
        <BatchExecutionServerName>string</BatchExecutionServerName>
        <BatchRequestPickupTime>dateTime</BatchRequestPickupTime>
      </GetSendRouteMessagesStatusResult>
    </GetSendRouteMessagesStatusResponse>
  </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>
    <GetSendRouteMessagesStatus xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <OperationStatusGuid>guid</OperationStatusGuid>
      </request>
    </GetSendRouteMessagesStatus>
  </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>
    <GetSendRouteMessagesStatusResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetSendRouteMessagesStatusResult>
        <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>
        <BatchProcessRunning>boolean</BatchProcessRunning>
        <OperationState>NotStarted or Started or InProgress or Completed</OperationState>
        <OperationStatusGuid>guid</OperationStatusGuid>
        <BatchOperationStartTime>dateTime</BatchOperationStartTime>
        <BatchOperationEndTime>dateTime</BatchOperationEndTime>
        <RequestedOperationsCount>int</RequestedOperationsCount>
        <OperationsProcessed>int</OperationsProcessed>
        <SuccessfulOperationsCount>int</SuccessfulOperationsCount>
        <FailedOperationsCount>int</FailedOperationsCount>
        <DoSendRouteMessageResponses>
          <DoSendRouteMessageResponse>
            <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>
            <VehicleIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </VehicleIds>
            <MessageIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </MessageIds>
            <RecordId>int</RecordId>
          </DoSendRouteMessageResponse>
          <DoSendRouteMessageResponse>
            <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>
            <VehicleIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </VehicleIds>
            <MessageIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </MessageIds>
            <RecordId>int</RecordId>
          </DoSendRouteMessageResponse>
        </DoSendRouteMessageResponses>
        <WebServerName>string</WebServerName>
        <BatchProcessId>int</BatchProcessId>
        <StatusUpdateTime>dateTime</StatusUpdateTime>
        <BatchExecutionServerName>string</BatchExecutionServerName>
        <BatchRequestPickupTime>dateTime</BatchRequestPickupTime>
      </GetSendRouteMessagesStatusResult>
    </GetSendRouteMessagesStatusResponse>
  </soap12:Body>
</soap12:Envelope>