OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

DoSendForms

This method sends list of form instance messages to the specified vehicles.

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

<?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>
    <DoSendForms xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
        <SendFormInstanceMessages>
          <SendFormInstanceMessage>
            <RecipientIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </RecipientIds>
            <MessageType>int</MessageType>
            <MessageBody>string</MessageBody>
            <ReplyToMessageId>guid</ReplyToMessageId>
            <PriorityReadEnabled>boolean</PriorityReadEnabled>
            <TrackingID>guid</TrackingID>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <BaseFieldValues>
              <Values>
                <BaseFieldValue />
                <BaseFieldValue />
              </Values>
            </BaseFieldValues>
            <FormInstanceFieldCount>int</FormInstanceFieldCount>
          </SendFormInstanceMessage>
          <SendFormInstanceMessage>
            <RecipientIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </RecipientIds>
            <MessageType>int</MessageType>
            <MessageBody>string</MessageBody>
            <ReplyToMessageId>guid</ReplyToMessageId>
            <PriorityReadEnabled>boolean</PriorityReadEnabled>
            <TrackingID>guid</TrackingID>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <BaseFieldValues>
              <Values>
                <BaseFieldValue />
                <BaseFieldValue />
              </Values>
            </BaseFieldValues>
            <FormInstanceFieldCount>int</FormInstanceFieldCount>
          </SendFormInstanceMessage>
        </SendFormInstanceMessages>
        <Culture>string</Culture>
      </request>
    </DoSendForms>
  </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>
    <DoSendFormsResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <DoSendFormsResult>
        <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>
        <SendFormsOperationStatuses>
          <SendFormsOperationStatus>
            <TrackingID>guid</TrackingID>
            <FormErrorMessages>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
            </FormErrorMessages>
            <RecipientStatuses>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
            </RecipientStatuses>
            <FormInstanceResults>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
            </FormInstanceResults>
            <Status>int</Status>
          </SendFormsOperationStatus>
          <SendFormsOperationStatus>
            <TrackingID>guid</TrackingID>
            <FormErrorMessages>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
            </FormErrorMessages>
            <RecipientStatuses>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
            </RecipientStatuses>
            <FormInstanceResults>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
            </FormInstanceResults>
            <Status>int</Status>
          </SendFormsOperationStatus>
        </SendFormsOperationStatuses>
      </DoSendFormsResult>
    </DoSendFormsResponse>
  </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>
    <DoSendForms xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
        <SendFormInstanceMessages>
          <SendFormInstanceMessage>
            <RecipientIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </RecipientIds>
            <MessageType>int</MessageType>
            <MessageBody>string</MessageBody>
            <ReplyToMessageId>guid</ReplyToMessageId>
            <PriorityReadEnabled>boolean</PriorityReadEnabled>
            <TrackingID>guid</TrackingID>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <BaseFieldValues>
              <Values>
                <BaseFieldValue />
                <BaseFieldValue />
              </Values>
            </BaseFieldValues>
            <FormInstanceFieldCount>int</FormInstanceFieldCount>
          </SendFormInstanceMessage>
          <SendFormInstanceMessage>
            <RecipientIds>
              <guid>guid</guid>
              <guid>guid</guid>
            </RecipientIds>
            <MessageType>int</MessageType>
            <MessageBody>string</MessageBody>
            <ReplyToMessageId>guid</ReplyToMessageId>
            <PriorityReadEnabled>boolean</PriorityReadEnabled>
            <TrackingID>guid</TrackingID>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <BaseFieldValues>
              <Values>
                <BaseFieldValue />
                <BaseFieldValue />
              </Values>
            </BaseFieldValues>
            <FormInstanceFieldCount>int</FormInstanceFieldCount>
          </SendFormInstanceMessage>
        </SendFormInstanceMessages>
        <Culture>string</Culture>
      </request>
    </DoSendForms>
  </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>
    <DoSendFormsResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <DoSendFormsResult>
        <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>
        <SendFormsOperationStatuses>
          <SendFormsOperationStatus>
            <TrackingID>guid</TrackingID>
            <FormErrorMessages>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
            </FormErrorMessages>
            <RecipientStatuses>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
            </RecipientStatuses>
            <FormInstanceResults>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
            </FormInstanceResults>
            <Status>int</Status>
          </SendFormsOperationStatus>
          <SendFormsOperationStatus>
            <TrackingID>guid</TrackingID>
            <FormErrorMessages>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
              <Message>
                <MessageCode>int</MessageCode>
                <FieldName>string</FieldName>
              </Message>
            </FormErrorMessages>
            <RecipientStatuses>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
              <RecipientStatus>
                <RecipientID>guid</RecipientID>
                <VehicleErrorMessages>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                  <Message>
                    <MessageCode>int</MessageCode>
                    <FieldName>string</FieldName>
                  </Message>
                </VehicleErrorMessages>
                <Status>boolean</Status>
              </RecipientStatus>
            </RecipientStatuses>
            <FormInstanceResults>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
              <FormInstanceResult>
                <FormInstanceID>guid</FormInstanceID>
              </FormInstanceResult>
            </FormInstanceResults>
            <Status>int</Status>
          </SendFormsOperationStatus>
        </SendFormsOperationStatuses>
      </DoSendFormsResult>
    </DoSendFormsResponse>
  </soap12:Body>
</soap12:Envelope>