Service Description



asrv.aero

Flight Data Request Service Extended v 3.0



Namespace: http://www.asrv.aero/webservices/3.0/FlightDataRequestServiceExtended/



Document revisions

Date

Description

Author


Under development



1. Service facts

2. Introduction

2.1. Overview

This service is to make all available data related to flight legs available, including passenger and baggage data. For this reason the service will be strictly secured an will only be available to select partner after careful considerations. 

2.2. Implementation considerations

Any implementation of this service MUST use the XSD files provided here: XSDs

It is however up to the service provider which data elements to support, and how much data to return for requests spanning a long time period. To enable this most elements are optional. The reason for a service provider to not support all elements might be business rules related to data distribution, that it doesn't have the information, or that it wants to provide information in other (more restricted) ways.

Any service provider should make available documentation about the actual implementation, including:

    • the address of the service.
    • any limitations in the implementation.
    • recommended and allowed polling intervals.

2.3. Purpose of this service description

This service description has the following purpose:

      • Describe of service in enough detail for a service provider to implement it.
      • Describe the service so that a client (of this service) developer can use it.
      • Make available the XSD files necessary to implement and use the service.
      • Make it possible for relevant people at airports, airlines, handlers and other aviation partners to understand the available functionality and then to decide if to implement/use it or not.

2.4. Intended readership

    • IT architects
    • Developers
    • Business architects
    • Interested parties in the aviation community

3. Service overview

The figure below shows the available operations on the Flight Data Request Service Extended v 3.0. The operations are described in detail in Service operations


3.1. Standard parameters for the request operations

All request operations use the same parameters, only the results are different.

All parameters are optional.

All operations follow the same pattern: GetXXX( UniqueFlightLegId, FlightId, OperatingAirlineIATA, AirportIATA, hoursBefore, hoursAfter, startTime, endTime, onlyUpdatedAfter): YYYY

The semantics of each parameter are described in the table below.


Parameter Comments
uniqueFlightLegId : UniqueFlightLegId

Invalidates all other parameters if used.
Return the corresponding flight leg data. 
If missing, indicates that flight leg data for all UniqueFlightLegIds should be returned.

flightId : FlightId

Ignored if UniqueFlightLegId is used.

Return flight leg data with matching FlightId
If missing, indicates that flight leg data for all FlightIds should be returned.

operatingAirlineIATA : OperatingAirlineIATA

Ignored if UniqueFlightLegId is used.

Return flight leg data with matching OperatingAirlineIATA
If missing, indicates that flight leg data for all OperatingAirlineIATAs should be returned.

airportIATA : AirportIATA 

Ignored if UniqueFlightLegId is used.

Return flight leg data where

If missing, indicates that flight leg data for all airports supported by the provider should be returned.

hoursBefore : Count

Ignored if UniqueFlightLegId or startTime/endTime is used.

The number of hours before the current time for which data is wanted. What is compared to the current time can vary with implementations. It will typically be:

  • For flight leg oriented operations: 
  • For inbound oriented operations:
  • For outbound oriented operations:

Default: 1 

hoursAfter : Count

The number of hours after the current time for which data is wanted.
See also description above. 

Default: 7

startTime : DateTimeUTC

Ignored if UniqueFlightLegId is used. Invalidates hoursBefore/hoursAfter.

Only flight leg data for flights with SOBT/SIBT or EOBT/EIBT after startTime is returned.  Other times might be used depending on the implementation. See also "hoursBefore".

endTime : DateTimeUTC 

Ignored if UniqueFlightLegId is used. Invalidates hoursBefore/hoursAfter. 

Default: startTime +24h

Error if used without startTime. 

onlyUpdatedAfter : DateTimeUTC

Only flight legs that have been updated after "onlyUpdatedAfter" is returned.


4. Service operations

4.1. GetFlightLegStateData ( parameter list ) : FlightLegStateDataResponse

Returns data about the set of flights legs that fit the parameter list. 

Parameters:

See Standard parameters for the request operations for the possible parameters.

Returns:

5. Data entities

5.1. FlightLegStateDataResponse

ADD Term Comments

responseTimestamp

Timestamp indicating the latest possible update time for any record in the result data set. If used as onlyUpdatedAfter (see Standard parameters for the request operations) retrieving all updates are guaranteed.
FlightLegStateMetadata

See FlightLegStateMetadata for details.

FlightLegStateData

See Flight Leg State Data version 3.0 for details about the returned flight leg state data.


5.2. FlightLegStateMetadata

ADD Term / Entity Comments
CreatedSource

CreatedSource will be the first element in DataSources.

CreatedSourceOrganization The organization that is the source of CreatedSource.

CreatedTimestamp


LastUpdatedTimestamp
DataSources

NB! As data comes from a new source, and is matched to one flight leg, the source is just added to the DataSources list regardless of the new data actually updating the flight leg or not. 

NB! In some cases DataSources can be longer than allowed by the type. In this case sources will be removed from the DataSources string until it is within the allowed length. The oldest sources  are removed first. The first source to be removed would then be the CreatedSource.

ReferenceDataStatus


ClassificationLevel

NB! ClassificationLevel = "PUBLIC" does not mean that all information, like passenger numbers, are public information, only that the flight leg itself is. 

Default value is "NON-PUBLIC".

MergedIntoUniqueFlightLegId
FlightLegIsDeleted Indicates that this flight leg has been deleted.


6. XSDs

No files shared here yet.