Parameters for the request operations
All parameters are optional except parameter airport.
NB! All the parameters and its values are case-sensitive.
The semantics of each parameter are described in the table below.
| Parameter | Values | Description / Comments | For example |
|---|
| airport | Required max: 3-4 characters value, ex. OSL, BGO, TOS | The operating airport that considers the flight leg orientations. Formatting is given as IATA airport code and must written in uppercase letters. Parameter is required! | airport=OSL, airport=BGO, etc. |
| TimeFrom | Optional defaults to value: 1 if not set Max value: |
96| 36 | The number of hours before the current time for which data is wanted. Example: Present time = 08:01, TimeFrom=1, TimeTo=7. Results will contain data between 07:00 and 15:00. Present time = 08:59, TimeFrom=1, TimeTo=7. Results will contain data between 07:00 and 15:00. Flights are selected based on ProbOBT from ARDB. | TimeFrom=1 |
| TimeTo | Optional defaults to value: 7 if not set Max value: |
144| 744 | The number of hours after the current time for which data is wanted. Example: Present time = 08:01, TimeFrom=1, TimeTo=7. Results will contain data between 07:00 and 15:00. Present time = 08:59, TimeFrom=1, TimeTo=7. Results will contain data between 07:00 and 15:00. Flights are selected based on ProbIBT from ARDB. | TimeTo=7 |
| direction | Optional Accepted: A or D If not set: both flight-directions | If the parameter direction is set, then the Flights will be filtered by A=Arrivals or D=Departures. If parameter direction is not set then fetch all flight leg data for both orientations. | direction=A or direction=D |
| cdm | Optional Accepted: Y | If cdm=Y is set then cdm data as TOBT, TSAT and EIBT is added to the flight. If not set cdm data is not added. | cdm=Y |
| additional | Optional Accepted: Y | if the parameter additional is set to “Y” then additional data as Airline, Flight Number, Status |
and Delayed is | , Delayed and some passenger numbers are added to Flight. | additional=Y |
| lastUpdate | Optional Accepted format: yyyy-MM-ddTHH:mm:ssZ ex: 2023-01-20T13:02:37Z | If set, then Flights that are updated after the given timestamp within the period of TimeFrom and TimeTo. Datetime has to be given in UTC/Z zone. Recommended for polling-applications looking for new updates to flights. | lastUpdate=2023-01-03T09:30:00Z |
| handlingdata | Optional Accepted: Y | If handlingdata=Y is set then HandlerData as HandlerCode, HandlerName and HandlerServiceType is added to flights. If not set, HandlerData is not added. | handlingdata=Y |
| gateClosedTime | Optional Accepted: Y | If set then gateClosedTime will be added to departure-flights with a gateClosedTime, if the data exists. Example value of gateClosedTime: 2023-03-14T10:35:12Z | gateClosedTime=Y |
| codeshare | Optional Accepted: Y | If set then codeshareinfo is added to flight. CodeshareInfo consists of codeshareAirlineDesignators, codeshareAirlineNames, codeshareFlightNumbers and codeshareOperationalSuffixs. | codeshare=Y |
| arrivalGate | Optional Accepted: Y | If set then gate is added to arrival-flight. | arrivalGate=Y |
| atm | Optional Accepted: Y | If atm=Y is set, then ATM Estimated Landing Time (ELDT) is added to the flight. If not set, ELDT data is not added. | atm=Y |
Please note that if incorrect syntax is used on a parameter, that parameter will be left out and its default values will be used.
Examples where parameters are used
...
in url:
Link for internal consumers in production
Test:
https://services-test.avinor.no/XmlFeedOperativXmlFeedOperative/v1.0?airport=BGO&TimeFrom=1&TimeTo=4&direction=A&cdm=Y&additional=Y&lastUpdate=2023-01-20T13:02:37.340Z&handlingdata=Y&gateClosedTime=Y&codeshare=Y&arrivalGate=Y
Link for external consumers in productionProd:
https://asrv.avinor.no/XmlFeedOperativXmlFeedOperative/v1.0?airport=BGO&TimeFrom=1&TimeTo=4&direction=A&cdm=Y&additional=Y&lastUpdate=2023-01-20T13:02:37.340Z&handlingdata=Y&gateClosedTime=Y&codeshare=Y&arrivalGate=Y
Link to test environmentOpenApi-definition:
https://services-test.avinor.no/XmlFeedOperativ/v1/api-docs
Service Response Attributes
The XMLFeedOperativ service response has the following required attributes mapped to their corresponding data model elements :
| Code Block |
|---|
|
| Service attribute | Data model element |
| :-----------------------------------: | :-----------------------------------------------------------: |
| airport.name | The IATA code for the requested airport (request parameters). |
| airport.flights.lastUpdate | FlightLeg.FlightLegMetaData.modifiedDateTime |
| airport.flights.flight.uniqueID | FlightLeg.id |
| airport.flights.flight.status.code | No term, calculated to produce |
| | N - New info |
| | E - Estimated time |
| | A - Landed |
| | C - Cancelled |
| | D - Departured |
| airport.flights.flight.status.time | next_information_time |
|
XmlFeedOperative/v1.0?airport=BGO&TimeFrom=1&TimeTo=4&direction=A&cdm=Y&additional=Y&lastUpdate=2023-01-20T13:02:37.340Z&handlingdata=Y&gateClosedTime=Y&codeshare=Y&arrivalGate=Y
General sorting rules
The flights are sorted on: schedule_time, flight_id
XML schema file.
The XML schema files for the LETIS based service is obtained from the URL:
Service field mapping
| Service term | ADD term | ARDB column | | Comment |
|---|
| flight_id | FlightId (NB! Is formatted) |
flight_idflight_departure_date | flight_di_indicator |
|
| schedule_time | SIBT for arrivals, SOBT for departures |
sibt, sobt | NA | arrival_airport_iata, departure_airport_iata | flight_route_iata | check_in_display_textgate_datagate_data | baggage_claim_unit | last_bag or belt_first_bagIf BeltLastBag | status = C else if BeltFirstBag is set, belt_status = O |
| belt_start | BeltFirstBag |
belt_first_bagAircraftParkingPositionArrival or ELDT or ETOT or ALDT or AIBT or NextInformationTimeAOBTATOTEOBTAircraftParkingPositionDepartureBeltLastBag | belt_last_bag | stand | aircraft_parking_position_arrival, aircraft_parking_position_departure | Field type depends on flight direction |
| est_time |
eldt, etot, eobt | ELDT for Arrival, for departure If EOBT is set uses it, else ETOT | act_time | aldt, atot | aldt if arrival, else atot if departureaibt, aobt | | AIBT or AOBT | Arrival: AIBT. Departure: AOBT |
aibt if arrival, else aobt if departure_information_timeif arrival lnk_arv_flight_id, lnk_dep_flight_id | | Arrival: LinkedDeparture.FlightId |
, else departure | . Departure: LinkedArrival.FlightId |
| linked_flight_key | NA |
NA | or DepartureDelayarrival_delay or departure_delayarrival_delay or departure_delay | flight_leg_status | Checks if flight status is "CANCELED" returns true/false |
| cdm_eibt | EIBT |
eibt | NA | Avledes Alltid | always 'N'. AltiFlightLeqQuery |
returnerer faktiske flygninger og ikke flight_service_type_iata | This is the type of service provided aircraft by the one | One letter IATA service type code e.g. ‘J’ (Schedule passenger) and ‘C’ (Charter passenger). There are no restrictions on service type. |
| aircraft_type | AircraftIATAType |
|
| aircraft_ |
iata_typeaircraft_aircraft_registration | tow | NA | NA | trip_fuel | NA | NA | zew_fuel | NA | NA | fuel_ramp_requested | If arrival will display public, if departure will not filter by typeflight_leg_remark | | Public remark, shown on Public Surfaces, such as FIDS screens and web pages. |
| remark_2 | RemarkData.RemarkText |
flight_leg_remark | Will only show staff departure no matter direction| Staff remark, only shown to handlers, airline and airport employees. Visible in mAOS and flightviewer. |
| cdm_tobt | TOBT |
tobttsat | operating_airline_iata |
|
| flight_number | NOT in model (Part of FlightId) |
NOT in model | ELDTnext_information_time, aobt, atot, eobt, etot, eldt| SOBT, AirlineELDT, AirlineEOBT | If status_code = ’’: status_time = ’’ If status_code = ’N’: status_time = ’NEXT_INFO’ If status_code = ’E’: status_time = |
’EOBT ETOT’ departures, ’ELDT’ | arrivals, 'AirlineEOBT'/’EOBT’ or 'ETOT' - for |
arrivals departures If status_code = ’D’: status_time = |
’OFF_BLOCK_TIME’ ’AOBT’ or 'ATOT' – for departures If status_code = ’A’: status_time = |
’ELDT’ ’ALDT’ or 'AIBT' – for arrivals If status_code = ’C’: status_time = ’’
If AirlineELDT or AirlineEOBT are empty, use the ATM estimated times (e.g. ELDT, EOBT) |
| delayed | NA |
NA | Is derived: calculated (ALDT, ELDT, SIBT) for arrival or (AOBT, ETOT, SOBT) for departure. | Arrival: Is derived from ProbLDT, ProbIBT, SIBT. Departure: Is derived from ProbOBT, SOBT. delayed = Y if SIBT/SOBT - Prob time > 15 min After summer vacation 2026, this definition will be implemented: Arrival 1. If ALDT is not null and ALDT - SIBT >= 16 min => delayed = Y 2. If ALDT is null and Airline_ELDT is not null and Airline_ELDT - SIBT >= 16 min => delayed = Y 3. If ALDT is null and Airline_ELDT is null and ELDT is not null and ELDT - SIBT >= 16 min => delayed = Y Departure 1. If AOBT is not null and AOBT - SOBT >= 16 min => delayed = Y 2. If AOBT is null and Airline_EOBT is not null and Airline_EOBT - SOBT >= 16 min => delayed = Y 3. If AOBT is null and Airline_EOBT is null and EOBT is not null and EOBT - SOBT >= 16 min => delayed = Y |
| codeshare_key |
codeshare_key | NAhandler_arrival or handler_departure | handler_arrival or handler_departureNA | gate_data | Example value: 2023-03-14T10:35:12Z |
| codeshareAirlineDesignators | NA |
code_share | code_share | code_share |
|
| codeshareOperationalSuffixs | NA |
code_share | Time specifications:
All times are listed in UTC format and are in the format ISO 8601 (Wikipedia: ISO 8601-format) [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]Z. Please make sure to adjust for time zone and summer time as required.
Example: 2009-12-31T16:00:00 corresponds to 31. Descember 2009 17:00 o'clock local time in Norway (CET), while 2009-06-23T16:00:00 correcsponds to 23. June 2009 18:00 o'clock local time in Norway (Summertime).For more information about each field please look: Avinor Data Definition
References
- Airport Data Dictionary
- AltiFlightLegQuery
- Format of XMLfeed Operativ v1-10 (word document)