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: 36 | The number of hours before the current time for which data is wanted. Example: Flights are selected based on ProbOBT from ARDB. | TimeFrom=1 |
| TimeTo | Optional defaults to value: 7 if not set Max value: 744 | The number of hours after the current time for which data is wanted. Example: 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 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 |
| paxFromLoad | Optional Accepted: Y | If set then paxBoarding(departure flights) and paxDisembarking(arrival flights) will be displayed. | paxFromLoad=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:
Link for internal consumers in production:
https://services.avinor.no/XmlFeedOperativeWithPax/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 production:
https://asrv.avinor.no/XmlFeedOperativeWithPax/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 environment:
https://services-test.avinor.no/XmlFeedOperativeWithPax/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 | Comment |
|---|---|---|
| flight_id | FlightId | |
| date_of_operation | FlightDepartureDate | |
| dom_int | FlightDIIndicator | |
| schedule_time | SIBT for arrivals, SOBT for departures | |
| arr_dep | N/A | "A" - Arrival, "D" - Departure |
| airport | ArrivalAirportIATA or DepartureAirportIATA | |
| via_airport | FlightRouteIATA | Derives from flightId, multi flight, +++ |
| check_in | CheckInDisplayText | |
| gate | Gate | |
| gate_status | GateStatus | |
| belt | BaggageClaimUnit | |
| belt_status | BeltLastBag or BeltFirstBag | If BeltLastBag = C else BeltFirstBag = O |
| belt_start | BeltFirstBag | |
| belt_stop | BeltLastBag | |
| stand | AircraftParkingPositionArrival, AircraftParkingPositionDeparture | Field type depends on flight direction |
| est_time | ELDT or ETOT or EOBT | Arrival: ELDT. Departure: EOBT if set, else ETOT |
| act_time | ALDT or ATOT | Arrival: ALDT. Departure: ATOT |
| onb_ofb_time | AIBT or AOBT | Arrival: AIBT. Departure: AOBT |
| next_info | NextInformationTime | The dateTime of next information |
| linked_flight | LinkedArrival.FlightId or LinkedDeparture.FlightId | if arrival LinkedDeparture.FlightId, else departure LinkedArrival.FlightId |
| last_delay_code | ArrivalDelay or DepartureDelay | |
| last_delay_code2 | ArrivalDelay or DepartureDelay | |
| cancelled_flag | FlightLegStatus | Checks if flight status is "CANCELED" returns true/false |
| codeshare_ind | 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 | One letter IATA service type code e.g. ‘J’ (Schedule passenger) and ‘C’ (Charter passenger). No restrictions on service type. |
| aircraft_reg | AircraftData.AircraftRegistration | Registration number of the aircraft |
| ramp_fuel | DepartureData.FuelRampRequested | Field ramp fuel (IR1 message), must convert from _Kilo to fuelType. |
| remark_1 | RemarkData.RemarkText | If arrival will display public, if departure will not filter by type |
| remark_2 | RemarkData.RemarkText | Will only show staff departure no matter direction |
| cdm_tobt | TOBT | |
| cdm_tsat | TSAT | |
| cdm_eibt | EIBT | |
| airline | OperatingAirlineIATA | |
| flight_number | FlightNumber (part of FlightId) | Is derived from FlightId |
| status | NextInformationTime, ALDT, AIBT, ELDT, SIBT, AOBT, ATOT, EOBT, ETOT, SOBT | If status_code = ’’: status_time = ’’ If status_code = ’N’: status_time = ’NEXT_INFO’ If status_code = ’E’: status_time = ’ELDT’ - for arrivals, ’EOBT’ or 'ETOT' - for departures If status_code = ’D’: status_time = ’AOBT’ – for departures (ATOT if AOBT is not present) If status_code = ’A’: status_time = ’ALDT’ – for arrivals (AIBT if ALDT is not present) If status_code = ’C’: status_time = ’’ |
| delayed | NOT in model | Arrival: Is derived from ProbLDT, ProbIBT, SIBT Departure: Is derived from ProbOBT, SOBT. |
| handlingAgent | ArrivalData.HandlerName or DepartureData.HandlerName | |
| handlingAgentCode | ArrivalData.HandlerCode or DepartureData.HandlerCode | |
| codeshare_key | N/A | |
| flight_leg_key | N/A | |
| total_pax | PassengerData.PaxSeatedOnBoard | |
| total_ple | PaxEstimateDisembarking or PaxEstimateBoarding | PaxEstimateDisembarking for arrival or PaxEstimateBoarding for departure |
| total_transfer | PaxTransferDisembarking or PaxTransferBoarding | PaxTransferDisembarking for arrival or PaxTransferBoarding for departure |
| gateClosedTime | GateClose | Example value: 2023-03-14T10:35:12Z |
| codeshareAirlineDesignators | NA | |
| codeshareAirlineNames | CodeshareAirlineIATA | |
| codeshareFlightNumbers | CodeshareFlightNumber | |
| codeshareOperationalSuffixs | NA |
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).