OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

GetHOSProfileTables

Get all HOS Profile Tables (Regulations, Regulation Cycle, Regulation Types, Timezone, Status Definition - plus Carrier Information and Terminal for the specified 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/GetHOSProfileTables"

<?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>
    <GetHOSProfileTables xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerID>guid</OwnerID>
      </request>
    </GetHOSProfileTables>
  </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>
    <GetHOSProfileTablesResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetHOSProfileTablesResult>
        <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>
        <DriverTimeZones>
          <DriverTimeZone>
            <TzUID>guid</TzUID>
            <TzDisplayName>string</TzDisplayName>
            <TzStandardName>string</TzStandardName>
            <TzOffset>int</TzOffset>
            <TzDLS>int</TzDLS>
            <Comment>string</Comment>
          </DriverTimeZone>
          <DriverTimeZone>
            <TzUID>guid</TzUID>
            <TzDisplayName>string</TzDisplayName>
            <TzStandardName>string</TzStandardName>
            <TzOffset>int</TzOffset>
            <TzDLS>int</TzDLS>
            <Comment>string</Comment>
          </DriverTimeZone>
        </DriverTimeZones>
        <RegulationTypes>
          <RegulationType>
            <RegTypeUID>guid</RegTypeUID>
            <RegTypeID>int</RegTypeID>
            <RegTypeName>string</RegTypeName>
          </RegulationType>
          <RegulationType>
            <RegTypeUID>guid</RegTypeUID>
            <RegTypeID>int</RegTypeID>
            <RegTypeName>string</RegTypeName>
          </RegulationType>
        </RegulationTypes>
        <TerminalData>
          <HOSTerminal>
            <TerminalName>string</TerminalName>
            <TerminalID>int</TerminalID>
            <OwnerID>guid</OwnerID>
          </HOSTerminal>
          <HOSTerminal>
            <TerminalName>string</TerminalName>
            <TerminalID>int</TerminalID>
            <OwnerID>guid</OwnerID>
          </HOSTerminal>
        </TerminalData>
        <StatusDefinitions>
          <StatusDefinition>
            <HOSStatus>int</HOSStatus>
            <Definition>string</Definition>
          </StatusDefinition>
          <StatusDefinition>
            <HOSStatus>int</HOSStatus>
            <Definition>string</Definition>
          </StatusDefinition>
        </StatusDefinitions>
        <UniqueRegulations>
          <UniqueRegulation>
            <RegName>string</RegName>
            <RegTypeUID>guid</RegTypeUID>
            <RegID>guid</RegID>
            <RuleID>int</RuleID>
          </UniqueRegulation>
          <UniqueRegulation>
            <RegName>string</RegName>
            <RegTypeUID>guid</RegTypeUID>
            <RegID>guid</RegID>
            <RuleID>int</RuleID>
          </UniqueRegulation>
        </UniqueRegulations>
        <Regulations>
          <RegulationWithMetaData>
            <RegID>guid</RegID>
            <RegName>string</RegName>
            <MaxDayID>guid</MaxDayID>
            <CycleDay>int</CycleDay>
            <MaxDay>int</MaxDay>
            <RegTypeName>string</RegTypeName>
            <RegTypeUID>guid</RegTypeUID>
          </RegulationWithMetaData>
          <RegulationWithMetaData>
            <RegID>guid</RegID>
            <RegName>string</RegName>
            <MaxDayID>guid</MaxDayID>
            <CycleDay>int</CycleDay>
            <MaxDay>int</MaxDay>
            <RegTypeName>string</RegTypeName>
            <RegTypeUID>guid</RegTypeUID>
          </RegulationWithMetaData>
        </Regulations>
        <Carrier>
          <CarrierID>guid</CarrierID>
          <OwnerID>guid</OwnerID>
          <CarrierName>string</CarrierName>
          <StreetAddress>string</StreetAddress>
          <StreetAddress2>string</StreetAddress2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <DotNumber>string</DotNumber>
        </Carrier>
      </GetHOSProfileTablesResult>
    </GetHOSProfileTablesResponse>
  </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>
    <GetHOSProfileTables xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerID>guid</OwnerID>
      </request>
    </GetHOSProfileTables>
  </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>
    <GetHOSProfileTablesResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetHOSProfileTablesResult>
        <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>
        <DriverTimeZones>
          <DriverTimeZone>
            <TzUID>guid</TzUID>
            <TzDisplayName>string</TzDisplayName>
            <TzStandardName>string</TzStandardName>
            <TzOffset>int</TzOffset>
            <TzDLS>int</TzDLS>
            <Comment>string</Comment>
          </DriverTimeZone>
          <DriverTimeZone>
            <TzUID>guid</TzUID>
            <TzDisplayName>string</TzDisplayName>
            <TzStandardName>string</TzStandardName>
            <TzOffset>int</TzOffset>
            <TzDLS>int</TzDLS>
            <Comment>string</Comment>
          </DriverTimeZone>
        </DriverTimeZones>
        <RegulationTypes>
          <RegulationType>
            <RegTypeUID>guid</RegTypeUID>
            <RegTypeID>int</RegTypeID>
            <RegTypeName>string</RegTypeName>
          </RegulationType>
          <RegulationType>
            <RegTypeUID>guid</RegTypeUID>
            <RegTypeID>int</RegTypeID>
            <RegTypeName>string</RegTypeName>
          </RegulationType>
        </RegulationTypes>
        <TerminalData>
          <HOSTerminal>
            <TerminalName>string</TerminalName>
            <TerminalID>int</TerminalID>
            <OwnerID>guid</OwnerID>
          </HOSTerminal>
          <HOSTerminal>
            <TerminalName>string</TerminalName>
            <TerminalID>int</TerminalID>
            <OwnerID>guid</OwnerID>
          </HOSTerminal>
        </TerminalData>
        <StatusDefinitions>
          <StatusDefinition>
            <HOSStatus>int</HOSStatus>
            <Definition>string</Definition>
          </StatusDefinition>
          <StatusDefinition>
            <HOSStatus>int</HOSStatus>
            <Definition>string</Definition>
          </StatusDefinition>
        </StatusDefinitions>
        <UniqueRegulations>
          <UniqueRegulation>
            <RegName>string</RegName>
            <RegTypeUID>guid</RegTypeUID>
            <RegID>guid</RegID>
            <RuleID>int</RuleID>
          </UniqueRegulation>
          <UniqueRegulation>
            <RegName>string</RegName>
            <RegTypeUID>guid</RegTypeUID>
            <RegID>guid</RegID>
            <RuleID>int</RuleID>
          </UniqueRegulation>
        </UniqueRegulations>
        <Regulations>
          <RegulationWithMetaData>
            <RegID>guid</RegID>
            <RegName>string</RegName>
            <MaxDayID>guid</MaxDayID>
            <CycleDay>int</CycleDay>
            <MaxDay>int</MaxDay>
            <RegTypeName>string</RegTypeName>
            <RegTypeUID>guid</RegTypeUID>
          </RegulationWithMetaData>
          <RegulationWithMetaData>
            <RegID>guid</RegID>
            <RegName>string</RegName>
            <MaxDayID>guid</MaxDayID>
            <CycleDay>int</CycleDay>
            <MaxDay>int</MaxDay>
            <RegTypeName>string</RegTypeName>
            <RegTypeUID>guid</RegTypeUID>
          </RegulationWithMetaData>
        </Regulations>
        <Carrier>
          <CarrierID>guid</CarrierID>
          <OwnerID>guid</OwnerID>
          <CarrierName>string</CarrierName>
          <StreetAddress>string</StreetAddress>
          <StreetAddress2>string</StreetAddress2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <DotNumber>string</DotNumber>
        </Carrier>
      </GetHOSProfileTablesResult>
    </GetHOSProfileTablesResponse>
  </soap12:Body>
</soap12:Envelope>