OnlineAVL Web Service

OnlineAVL Published Interface

Click here for a complete list of operations.

GetFormsDetails

This method provides a list of form instance detail for given message ids or vehicle ids or form number.

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: onlineavl2svc-uk.navmanwireless.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://onlineavl2.navmanwireless.com/0907/GetFormsDetails"

<?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>
    <GetFormsDetails xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
        <VehicleIds>
          <guid>guid</guid>
          <guid>guid</guid>
        </VehicleIds>
        <FormNumbers>
          <int>int</int>
          <int>int</int>
        </FormNumbers>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <SentBy>undefined or dispatcher or driver or both</SentBy>
        <FormInstanceIds>
          <guid>guid</guid>
          <guid>guid</guid>
        </FormInstanceIds>
      </request>
    </GetFormsDetails>
  </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>
    <GetFormsDetailsResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetFormsDetailsResult>
        <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>
        <MoreItemsAvailable>boolean</MoreItemsAvailable>
        <RemovedItems>
          <guid>guid</guid>
          <guid>guid</guid>
        </RemovedItems>
        <Version>long</Version>
        <FormInstanceDetailList>
          <FormInstanceDetail>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <FormName>string</FormName>
            <FormInstanceId>guid</FormInstanceId>
            <OwnerID>guid</OwnerID>
            <RecipientID>guid</RecipientID>
            <SenderID>guid</SenderID>
            <ThreadID>guid</ThreadID>
            <ParentId>guid</ParentId>
            <ThreadNumber>int</ThreadNumber>
            <SentDateTime>dateTime</SentDateTime>
            <MenuNumber>int</MenuNumber>
            <Latitude>double</Latitude>
            <Longitude>double</Longitude>
            <Reply>boolean</Reply>
            <IncomingForm>boolean</IncomingForm>
            <FormInstanceStatus>
              <ReceivedDateTime>dateTime</ReceivedDateTime>
              <FormDelivered>boolean</FormDelivered>
              <FormRead>boolean</FormRead>
              <ReadReceiptReceived>boolean</ReadReceiptReceived>
              <ReadReceiptReceivedDateTime>dateTime</ReadReceiptReceivedDateTime>
              <ReadReceiptActivityDateTime>dateTime</ReadReceiptActivityDateTime>
            </FormInstanceStatus>
            <StreetName>string</StreetName>
            <PriorityReadRequested>boolean</PriorityReadRequested>
            <ReadReceiptRequested>boolean</ReadReceiptRequested>
            <PriorityRead>int</PriorityRead>
            <ReadReceipt>int</ReadReceipt>
            <IsReadReceiptIncomingForm>boolean</IsReadReceiptIncomingForm>
            <DriverID>guid</DriverID>
            <DriverFirstName>string</DriverFirstName>
            <DriverLastName>string</DriverLastName>
            <UserID>guid</UserID>
            <Username>string</Username>
            <UserFirstName>string</UserFirstName>
            <UserLastName>string</UserLastName>
            <VehicleLocation>string</VehicleLocation>
            <GPSValid>boolean</GPSValid>
            <VehicleLatitude>int</VehicleLatitude>
            <VehicleLongitude>int</VehicleLongitude>
            <OffRoadMetres>double</OffRoadMetres>
            <DegreesBearing>int</DegreesBearing>
            <LocationType>int</LocationType>
            <RegionCode>string</RegionCode>
            <AreaCode>string</AreaCode>
            <NamedArea>long</NamedArea>
            <OriginalETADateTime>dateTime</OriginalETADateTime>
            <CurrentETADateTime>dateTime</CurrentETADateTime>
            <ETAState>None or InRouteOnTime or InRouteEarly or InRouteLate or Arrived or NavigationCancelled</ETAState>
            <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
            <CommunicationChannel>Default or Cellular or Satellite</CommunicationChannel>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
            <FormFields>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
            </FormFields>
          </FormInstanceDetail>
          <FormInstanceDetail>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <FormName>string</FormName>
            <FormInstanceId>guid</FormInstanceId>
            <OwnerID>guid</OwnerID>
            <RecipientID>guid</RecipientID>
            <SenderID>guid</SenderID>
            <ThreadID>guid</ThreadID>
            <ParentId>guid</ParentId>
            <ThreadNumber>int</ThreadNumber>
            <SentDateTime>dateTime</SentDateTime>
            <MenuNumber>int</MenuNumber>
            <Latitude>double</Latitude>
            <Longitude>double</Longitude>
            <Reply>boolean</Reply>
            <IncomingForm>boolean</IncomingForm>
            <FormInstanceStatus>
              <ReceivedDateTime>dateTime</ReceivedDateTime>
              <FormDelivered>boolean</FormDelivered>
              <FormRead>boolean</FormRead>
              <ReadReceiptReceived>boolean</ReadReceiptReceived>
              <ReadReceiptReceivedDateTime>dateTime</ReadReceiptReceivedDateTime>
              <ReadReceiptActivityDateTime>dateTime</ReadReceiptActivityDateTime>
            </FormInstanceStatus>
            <StreetName>string</StreetName>
            <PriorityReadRequested>boolean</PriorityReadRequested>
            <ReadReceiptRequested>boolean</ReadReceiptRequested>
            <PriorityRead>int</PriorityRead>
            <ReadReceipt>int</ReadReceipt>
            <IsReadReceiptIncomingForm>boolean</IsReadReceiptIncomingForm>
            <DriverID>guid</DriverID>
            <DriverFirstName>string</DriverFirstName>
            <DriverLastName>string</DriverLastName>
            <UserID>guid</UserID>
            <Username>string</Username>
            <UserFirstName>string</UserFirstName>
            <UserLastName>string</UserLastName>
            <VehicleLocation>string</VehicleLocation>
            <GPSValid>boolean</GPSValid>
            <VehicleLatitude>int</VehicleLatitude>
            <VehicleLongitude>int</VehicleLongitude>
            <OffRoadMetres>double</OffRoadMetres>
            <DegreesBearing>int</DegreesBearing>
            <LocationType>int</LocationType>
            <RegionCode>string</RegionCode>
            <AreaCode>string</AreaCode>
            <NamedArea>long</NamedArea>
            <OriginalETADateTime>dateTime</OriginalETADateTime>
            <CurrentETADateTime>dateTime</CurrentETADateTime>
            <ETAState>None or InRouteOnTime or InRouteEarly or InRouteLate or Arrived or NavigationCancelled</ETAState>
            <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
            <CommunicationChannel>Default or Cellular or Satellite</CommunicationChannel>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
            <FormFields>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
            </FormFields>
          </FormInstanceDetail>
        </FormInstanceDetailList>
      </GetFormsDetailsResult>
    </GetFormsDetailsResponse>
  </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: onlineavl2svc-uk.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>
    <GetFormsDetails xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <request>
        <Session>
          <SessionId>guid</SessionId>
        </Session>
        <Version>long</Version>
        <OwnerId>guid</OwnerId>
        <VehicleIds>
          <guid>guid</guid>
          <guid>guid</guid>
        </VehicleIds>
        <FormNumbers>
          <int>int</int>
          <int>int</int>
        </FormNumbers>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <SentBy>undefined or dispatcher or driver or both</SentBy>
        <FormInstanceIds>
          <guid>guid</guid>
          <guid>guid</guid>
        </FormInstanceIds>
      </request>
    </GetFormsDetails>
  </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>
    <GetFormsDetailsResponse xmlns="http://onlineavl2.navmanwireless.com/0907/">
      <GetFormsDetailsResult>
        <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>
        <MoreItemsAvailable>boolean</MoreItemsAvailable>
        <RemovedItems>
          <guid>guid</guid>
          <guid>guid</guid>
        </RemovedItems>
        <Version>long</Version>
        <FormInstanceDetailList>
          <FormInstanceDetail>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <FormName>string</FormName>
            <FormInstanceId>guid</FormInstanceId>
            <OwnerID>guid</OwnerID>
            <RecipientID>guid</RecipientID>
            <SenderID>guid</SenderID>
            <ThreadID>guid</ThreadID>
            <ParentId>guid</ParentId>
            <ThreadNumber>int</ThreadNumber>
            <SentDateTime>dateTime</SentDateTime>
            <MenuNumber>int</MenuNumber>
            <Latitude>double</Latitude>
            <Longitude>double</Longitude>
            <Reply>boolean</Reply>
            <IncomingForm>boolean</IncomingForm>
            <FormInstanceStatus>
              <ReceivedDateTime>dateTime</ReceivedDateTime>
              <FormDelivered>boolean</FormDelivered>
              <FormRead>boolean</FormRead>
              <ReadReceiptReceived>boolean</ReadReceiptReceived>
              <ReadReceiptReceivedDateTime>dateTime</ReadReceiptReceivedDateTime>
              <ReadReceiptActivityDateTime>dateTime</ReadReceiptActivityDateTime>
            </FormInstanceStatus>
            <StreetName>string</StreetName>
            <PriorityReadRequested>boolean</PriorityReadRequested>
            <ReadReceiptRequested>boolean</ReadReceiptRequested>
            <PriorityRead>int</PriorityRead>
            <ReadReceipt>int</ReadReceipt>
            <IsReadReceiptIncomingForm>boolean</IsReadReceiptIncomingForm>
            <DriverID>guid</DriverID>
            <DriverFirstName>string</DriverFirstName>
            <DriverLastName>string</DriverLastName>
            <UserID>guid</UserID>
            <Username>string</Username>
            <UserFirstName>string</UserFirstName>
            <UserLastName>string</UserLastName>
            <VehicleLocation>string</VehicleLocation>
            <GPSValid>boolean</GPSValid>
            <VehicleLatitude>int</VehicleLatitude>
            <VehicleLongitude>int</VehicleLongitude>
            <OffRoadMetres>double</OffRoadMetres>
            <DegreesBearing>int</DegreesBearing>
            <LocationType>int</LocationType>
            <RegionCode>string</RegionCode>
            <AreaCode>string</AreaCode>
            <NamedArea>long</NamedArea>
            <OriginalETADateTime>dateTime</OriginalETADateTime>
            <CurrentETADateTime>dateTime</CurrentETADateTime>
            <ETAState>None or InRouteOnTime or InRouteEarly or InRouteLate or Arrived or NavigationCancelled</ETAState>
            <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
            <CommunicationChannel>Default or Cellular or Satellite</CommunicationChannel>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
            <FormFields>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
            </FormFields>
          </FormInstanceDetail>
          <FormInstanceDetail>
            <FormNumber>int</FormNumber>
            <DefinitionNumber>int</DefinitionNumber>
            <FormName>string</FormName>
            <FormInstanceId>guid</FormInstanceId>
            <OwnerID>guid</OwnerID>
            <RecipientID>guid</RecipientID>
            <SenderID>guid</SenderID>
            <ThreadID>guid</ThreadID>
            <ParentId>guid</ParentId>
            <ThreadNumber>int</ThreadNumber>
            <SentDateTime>dateTime</SentDateTime>
            <MenuNumber>int</MenuNumber>
            <Latitude>double</Latitude>
            <Longitude>double</Longitude>
            <Reply>boolean</Reply>
            <IncomingForm>boolean</IncomingForm>
            <FormInstanceStatus>
              <ReceivedDateTime>dateTime</ReceivedDateTime>
              <FormDelivered>boolean</FormDelivered>
              <FormRead>boolean</FormRead>
              <ReadReceiptReceived>boolean</ReadReceiptReceived>
              <ReadReceiptReceivedDateTime>dateTime</ReadReceiptReceivedDateTime>
              <ReadReceiptActivityDateTime>dateTime</ReadReceiptActivityDateTime>
            </FormInstanceStatus>
            <StreetName>string</StreetName>
            <PriorityReadRequested>boolean</PriorityReadRequested>
            <ReadReceiptRequested>boolean</ReadReceiptRequested>
            <PriorityRead>int</PriorityRead>
            <ReadReceipt>int</ReadReceipt>
            <IsReadReceiptIncomingForm>boolean</IsReadReceiptIncomingForm>
            <DriverID>guid</DriverID>
            <DriverFirstName>string</DriverFirstName>
            <DriverLastName>string</DriverLastName>
            <UserID>guid</UserID>
            <Username>string</Username>
            <UserFirstName>string</UserFirstName>
            <UserLastName>string</UserLastName>
            <VehicleLocation>string</VehicleLocation>
            <GPSValid>boolean</GPSValid>
            <VehicleLatitude>int</VehicleLatitude>
            <VehicleLongitude>int</VehicleLongitude>
            <OffRoadMetres>double</OffRoadMetres>
            <DegreesBearing>int</DegreesBearing>
            <LocationType>int</LocationType>
            <RegionCode>string</RegionCode>
            <AreaCode>string</AreaCode>
            <NamedArea>long</NamedArea>
            <OriginalETADateTime>dateTime</OriginalETADateTime>
            <CurrentETADateTime>dateTime</CurrentETADateTime>
            <ETAState>None or InRouteOnTime or InRouteEarly or InRouteLate or Arrived or NavigationCancelled</ETAState>
            <IsSatelliteEnabled>boolean</IsSatelliteEnabled>
            <CommunicationChannel>Default or Cellular or Satellite</CommunicationChannel>
            <FormID>int</FormID>
            <FormDefinitionID>long</FormDefinitionID>
            <FormFields>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
              <FormField>
                <Name>string</Name>
                <Value>string</Value>
              </FormField>
            </FormFields>
          </FormInstanceDetail>
        </FormInstanceDetailList>
      </GetFormsDetailsResult>
    </GetFormsDetailsResponse>
  </soap12:Body>
</soap12:Envelope>