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 | The number of hours before the current time for which data is wanted. | TimeFrom=1 |
| TimeTo | Optional defaults to value: 7 if not set Max value: 144 | The number of hours after the current time for which data is wanted. | 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 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 |
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 all the parameters are used in url:
Alternatively use this link:
Service field mapping
Service term | ADD term | ARDB column | Comment | |
|---|---|---|---|---|
| flight_id | FlightId | flight_id | ||
| date_of_operation | FlightDepartureDate | flight_departure_date | ||
| dom_int | FlightDIIndicator | flight_di_indicator | ||
| schedule_time | SIBT for arrivals, SOBT for departures | sobt, sibt | ||
| arr_dep | N/A | N/A | "A" - Arrival, "D" - Departure | |
| airport | ArrivalAirportIATA or DepartureAirportIATA | arrival_airport_iata, departure_airport_iata | ||
| via_airport | FlightRouteIATA | flight_route_iata | Derives from flightId, multi flight, +++ | |
| check_in | CheckInDisplayText | check_in_display_text | ||
| gate | Gate | gate_data | ||
| gate_status | GateStatus | gate_data | ||
| belt | BaggageClaimUnit | baggage_claim_unit | ||
| belt_status | BeltLastBag or BeltFirstBag | belt_last_bag, belt_first_bag | If BeltLastBag = C else BeltFirstBag = O | |
| belt_start | BeltFirstBag | belt_first_bag | ||
| belt_stop | BeltLastBag | belt_last_bag | ||
| stand | AircraftParkingPositionArrival, AircraftParkingPositionDeparture | aircraft_parking_position_arrival, aircraft_parking_position_departure | Field type depends on flight direction | |
| est_time | ELDT or ETOT or EOBT | eldt, etot, eobt | ELDT for Arrival, for departure If EOBT is set uses it, else ETOT | |
| act_time | ALDT or ATOT | aldt, atot | aldt if arrival, else atot if departure | |
| onb_ofb_time | AIBT or AOBT | aibt, aobt | aibt if arrival, else aobt if departure | |
| next_info | NextInformationTime | next_information_time | ||
| linked_flight | LinkedArrival.FlightId or LinkedDeparture.FlightId | lnk_arv_flight_id, lnk_dep_flight_id | if arrival LinkedDeparture.FlightId, else departure LinkedArrival.FlightId | |
| last_delay_code | ArrivalDelay or DepartureDelay | arrival_delay or departure_delay | ||
| last_delay_code2 | ArrivalDelay or DepartureDelay | arrival_delay or departure_delay | ||
| cancelled_flag | FlightLegStatus | flight_leg_status | Checks if flight status is "CANCELED" returns true/false | |
| codeshare_ind | N/A | N/A | The AltiFlightLegQuery returns data for physical flights, possibly with information about code shares. In any case the FlightLeg is never a code share, value is always set to "N" | |
| service_type | FlightServiceTypeIATA | flight_service_type_iata | This field holds the type of service. This is the type of service provided aircraft by the one letter IATA service type code. | |
| aircraft_reg | AircraftData.AircraftRegistration | aircraft_registration | Registration number of the aircraft | |
| ramp_fuel | DepartureData.FuelRampRequested | fuel_ramp_requested | Field ramp fuel (IR1 message), must convert from _Kilo to fuelType. | |
| tow | AircraftData.AircraftMTOW | aircraftMTOW | ||
| trip_fuel | N/A | N/A | ||
| zew_fuel | N/A | N/A | ||
| remark_1 | RemarkData.RemarkText | flight_leg_remark | If arrival will display public, if departure will not filter by type | |
| remark_2 | RemarkData.RemarkText | flight_leg_remark | Will only show staff departure no matter direction | |
| cdm_tobt | TOBT | tobt | ||
| cdm_tsat | TSAT | tsat | ||
| cdm_eibt | EIBT | eibt | ||
| airline | OperatingAirlineIATA | operating_airline_iata | ||
| flight_number | FlightNumber (part of FlightId) | NOT in model | Is derived from FlightId | |
| status | NextInformationTime, AOBT, ATOT, EOBT, ETOT, ELDT | next_information_time, aobt, atot, eobt, etot, eldt | If status_code = ’’: status_time = ’’ If status_code = ’N’: status_time = ’NEXT_INFO’ If status_code = ’E’: status_time = ’EOBT / ETOT’ - for departures, ’ELDT’ - for arrivals If status_code = ’D’: status_time = ’OFF_BLOCK_TIME’ – for departures If status_code = ’A’: status_time = ’ELDT’ – for arrivals If status_code = ’C’: status_time = ’’ | |
| delayed | NOT in model | NOT in model | Is derived: calculated (ALDT, ELDT, SIBT) for arrival or (AOBT, ETOT, SOBT) for departure. | |
| handlingAgent | ArrivalData.HandlerName or DepartureData.HandlerName | handler_arrival or handler_departure | ||
| handlingAgentCode | ArrivalData.HandlerCode or DepartureData.HandlerCode | handler_arrival or handler_departure | ||
| codeshare_key | N/A | N/A | ||
| flight_leg_key | N/A | N/A | ||
| total_pax | PassengerData.PaxSeatedOnBoard | pax_seated_on_board | ||
| total_ple | PaxEstimateDisembarking or PaxEstimateBoarding | pax_estimate_disembarking or pax_estimate_boarding | PaxEstimateDisembarking for arrival or PaxEstimateBoarding for departure | |
| total_transfer | PaxTransferDisembarking or PaxTransferBoarding | pax_transfer_disembarking or pax_transfer_boarding | PaxTransferDisembarking for arrival or PaxTransferBoarding for departure | |
| gateClosedTime | GateClose | gate_data | Example value: 2023-03-14T10:35:12Z | |
| codeshareAirlineDesignators | NA | code_share | ||
| codeshareAirlineNames | CodeshareAirlineIATA | code_share | ||
| codeshareFlightNumbers | CodeshareFlightNumber | 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).