OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

GetPlanTemplates

Get Plan templates and attributes for a 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/GetPlanTemplates"

<?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>
    <GetPlanTemplates xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerID>guid</OwnerID>
      </request>
    </GetPlanTemplates>
  </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>
    <GetPlanTemplatesResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetPlanTemplatesResult>
        <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>
        <MoreItemsAvailable>boolean</MoreItemsAvailable>
        <RemovedItems>
          <guid>guid</guid>
          <guid>guid</guid>
        </RemovedItems>
        <Version>long</Version>
        <Templates>
          <Template>
            <TemplateID>guid</TemplateID>
            <Name>string</Name>
            <Description>string</Description>
            <OwnerID>guid</OwnerID>
            <IsActive>boolean</IsActive>
            <Attributes>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
            </Attributes>
          </Template>
          <Template>
            <TemplateID>guid</TemplateID>
            <Name>string</Name>
            <Description>string</Description>
            <OwnerID>guid</OwnerID>
            <IsActive>boolean</IsActive>
            <Attributes>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
            </Attributes>
          </Template>
        </Templates>
      </GetPlanTemplatesResult>
    </GetPlanTemplatesResponse>
  </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>
    <GetPlanTemplates xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerID>guid</OwnerID>
      </request>
    </GetPlanTemplates>
  </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>
    <GetPlanTemplatesResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetPlanTemplatesResult>
        <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>
        <MoreItemsAvailable>boolean</MoreItemsAvailable>
        <RemovedItems>
          <guid>guid</guid>
          <guid>guid</guid>
        </RemovedItems>
        <Version>long</Version>
        <Templates>
          <Template>
            <TemplateID>guid</TemplateID>
            <Name>string</Name>
            <Description>string</Description>
            <OwnerID>guid</OwnerID>
            <IsActive>boolean</IsActive>
            <Attributes>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
            </Attributes>
          </Template>
          <Template>
            <TemplateID>guid</TemplateID>
            <Name>string</Name>
            <Description>string</Description>
            <OwnerID>guid</OwnerID>
            <IsActive>boolean</IsActive>
            <Attributes>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
              <TemplateAttribute>
                <AttributeID>guid</AttributeID>
                <IsMandatory>boolean</IsMandatory>
                <InternalName>string</InternalName>
                <ExternalName>string</ExternalName>
                <DataTypeFormat>string</DataTypeFormat>
                <DataType>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</DataType>
                <ObjectType>None or Route or Stop or Job or Task</ObjectType>
                <PredefinedList>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                  <AttributePredefinedValue>
                    <AttributeID>guid</AttributeID>
                    <AttributeDataTypeID>None or Alphanumeric or Date or Time or Numeric or Geolocation or Address or Guid or Timezone or DateTime or Signature or Boolean or Email</AttributeDataTypeID>
                    <NumericValue>double</NumericValue>
                    <StringValue>string</StringValue>
                    <DateTimeValue>dateTime</DateTimeValue>
                    <Deleted>boolean</Deleted>
                  </AttributePredefinedValue>
                </PredefinedList>
              </TemplateAttribute>
            </Attributes>
          </Template>
        </Templates>
      </GetPlanTemplatesResult>
    </GetPlanTemplatesResponse>
  </soap12:Body>
</soap12:Envelope>