Service Description
asrv.aero
Flight Data Request Service Extended v 2.0
Namespace: http://www.asrv.aero/webservices/2.0/FlightDataRequestServiceExtended/
Document revisions
Date | Description | Author |
---|---|---|
2022-06-16 | Corrected operation name under "Service facts" | Ole Nymoen |
2022-05-18 | First complete version of the documentation. |
1. Service facts
-
Operations:
-
Service is accessed using HTTPS GET
-
Service security: Decided by implementation
-
Standard return codes are described here: HTTP Return Codes
2. Introduction
2.1. Overview
This service is an extended version of the Flight Data Request Service v 2.0. The services will be maintained in sync, and all core data returned by GetFlightLegDataExtended is identical to the data returned by GetFlightLegData. In addition passenger and more detailed baggage data is returned.
Flight Data Request Service Extended v 2.0 is defined as a separate service to enable a simpler security model. Since passenger numbers per flight are considered business sensitive data it is important to restrict access to this service.
Please see Flight Data Request Service v 2.0 for a general description of the service.
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 operations can retrieve the following types of data:
- Flight leg (departure and arrival) vith extended passenger and baggage data.
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. |
flightId : FlightId |
Ignored if UniqueFlightLegId is used. Return flight leg data with matching FlightId. |
operatingAirlineIATA : OperatingAirlineIATA |
Ignored if UniqueFlightLegId is used. Return flight leg data with matching OperatingAirlineIATA. |
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:
Default: 1 |
hoursAfter : Count |
The number of hours after the current time for which data is wanted. 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. |
3.2. HTTP Return Codes
Defined HTTP return codes. The service might use one or more of them. Return codes "expected" are listed for each operation.
4. Service operations
4.1. GetFlightLegDataExtended ( parameter list ) : FlightLegDataExtendedResponse
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:
- 200 OK and FlightLegDataExtendedResponse if everything went well and one or more flight legs was found.
- 200 OK if no flight legs fit the filtering.
- 400 Bad Request if there were something wrong with the parameter list, ref Standard parameters for the request operations.
- 404 Not found if UniqueFlightLegId was used as a parameter and the flight leg was not found.
5. Data entities
5.1. FlightLegDataExtended
FlightLegData has information about the departure and the arrival of one flight leg.
|
|
5.2. FlightLegDataExtendedResponse
|
|
5.3. PassengerData
|
|
5.4. LoadData
5.5. CargoData
5.6. TransferData
|
|