OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

DoSendRouteMessages

This method provides a mechanism for the client application to send multiple Route-To Messages to the MDT's on the supplied Vehicle(s). Note that the batch operation is done asynchronously. This method returns as soon as a batch execution process has been created to perform the batch operation.

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

<?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>
    <DoSendRouteMessages xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <SendDeleteTextMessageFirst>boolean</SendDeleteTextMessageFirst>
        <BulkId>guid</BulkId>
        <UserId>guid</UserId>
        <SendRouteMessageRequests>
          <DoSendRouteMessageRequest>
            <Session>
              <SessionId>guid</SessionId>
            </Session>
            <OutgoingRouteMessage>
              <RecipientIds>
                <guid>guid</guid>
                <guid>guid</guid>
              </RecipientIds>
              <MessageType>int</MessageType>
              <MessageBody>string</MessageBody>
              <ReplyToMessageId>guid</ReplyToMessageId>
              <ReplyToSentDateTime>dateTime</ReplyToSentDateTime>
              <PriorityReadEnabled>boolean</PriorityReadEnabled>
              <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
              <Longitude>double</Longitude>
              <Latitude>double</Latitude>
              <StreetName>string</StreetName>
            </OutgoingRouteMessage>
          </DoSendRouteMessageRequest>
          <DoSendRouteMessageRequest>
            <Session>
              <SessionId>guid</SessionId>
            </Session>
            <OutgoingRouteMessage>
              <RecipientIds>
                <guid>guid</guid>
                <guid>guid</guid>
              </RecipientIds>
              <MessageType>int</MessageType>
              <MessageBody>string</MessageBody>
              <ReplyToMessageId>guid</ReplyToMessageId>
              <ReplyToSentDateTime>dateTime</ReplyToSentDateTime>
              <PriorityReadEnabled>boolean</PriorityReadEnabled>
              <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
              <Longitude>double</Longitude>
              <Latitude>double</Latitude>
              <StreetName>string</StreetName>
            </OutgoingRouteMessage>
          </DoSendRouteMessageRequest>
        </SendRouteMessageRequests>
        <OperationStatusGuid>guid</OperationStatusGuid>
      </request>
    </DoSendRouteMessages>
  </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>
    <DoSendRouteMessagesResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <DoSendRouteMessagesResult>
        <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>
        <RequestedOperationsCount>int</RequestedOperationsCount>
        <OperationStatusGuid>guid</OperationStatusGuid>
      </DoSendRouteMessagesResult>
    </DoSendRouteMessagesResponse>
  </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>
    <DoSendRouteMessages xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <SendDeleteTextMessageFirst>boolean</SendDeleteTextMessageFirst>
        <BulkId>guid</BulkId>
        <UserId>guid</UserId>
        <SendRouteMessageRequests>
          <DoSendRouteMessageRequest>
            <Session>
              <SessionId>guid</SessionId>
            </Session>
            <OutgoingRouteMessage>
              <RecipientIds>
                <guid>guid</guid>
                <guid>guid</guid>
              </RecipientIds>
              <MessageType>int</MessageType>
              <MessageBody>string</MessageBody>
              <ReplyToMessageId>guid</ReplyToMessageId>
              <ReplyToSentDateTime>dateTime</ReplyToSentDateTime>
              <PriorityReadEnabled>boolean</PriorityReadEnabled>
              <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
              <Longitude>double</Longitude>
              <Latitude>double</Latitude>
              <StreetName>string</StreetName>
            </OutgoingRouteMessage>
          </DoSendRouteMessageRequest>
          <DoSendRouteMessageRequest>
            <Session>
              <SessionId>guid</SessionId>
            </Session>
            <OutgoingRouteMessage>
              <RecipientIds>
                <guid>guid</guid>
                <guid>guid</guid>
              </RecipientIds>
              <MessageType>int</MessageType>
              <MessageBody>string</MessageBody>
              <ReplyToMessageId>guid</ReplyToMessageId>
              <ReplyToSentDateTime>dateTime</ReplyToSentDateTime>
              <PriorityReadEnabled>boolean</PriorityReadEnabled>
              <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
              <Longitude>double</Longitude>
              <Latitude>double</Latitude>
              <StreetName>string</StreetName>
            </OutgoingRouteMessage>
          </DoSendRouteMessageRequest>
        </SendRouteMessageRequests>
        <OperationStatusGuid>guid</OperationStatusGuid>
      </request>
    </DoSendRouteMessages>
  </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>
    <DoSendRouteMessagesResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <DoSendRouteMessagesResult>
        <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>
        <RequestedOperationsCount>int</RequestedOperationsCount>
        <OperationStatusGuid>guid</OperationStatusGuid>
      </DoSendRouteMessagesResult>
    </DoSendRouteMessagesResponse>
  </soap12:Body>
</soap12:Envelope>