You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

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.

ParameterValuesDescription / CommentsFor example
airportRequired
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.
TimeFromOptional
defaults to value: 1 if not set
Max value: 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
TimeToOptional
defaults to value: 7 if not set
Max value: 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
directionOptional
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
cdmOptional
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
additionalOptional
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
lastUpdateOptional
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
handlingdataOptional
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
gateClosedTimeOptional
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:12ZgateClosedTime=Y
codeshareOptional
Accepted: Y
If set then codeshareinfo is added to flight. CodeshareInfo consists of codeshareAirlineDesignators, codeshareAirlineNames, codeshareFlightNumbers and codeshareOperationalSuffixs.codeshare=Y
arrivalGateOptional
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 parameters are used in url:

Link for internal consumers in production:
https://services.avinor.no/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

Link for external consumers in production:
https://asrv.avinor.no/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

Link to current solution:
https://flydata.avinor.no/XmlFeedOperativ.asp?airport=BGO&TimeFrom=1&TimeTo=4&direction=A&cdm=Y&additional=Y&handlingdata=Y&gateClosedTime=Y&codeshare=Y&arrivalGate=Y

Link to test environment:
https://services-test.avinor.no/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 termADD termARDB columnComment
flight_idFlightId (NB! Is formatted)flight_id
date_of_operationFlightDepartureDate (NB! Response is DateTime)flight_departure_date
dom_intFlightDIIndicatorflight_di_indicator
schedule_timeSIBT for arrivals, SOBT for departuressibt, sobt
arr_depNANA"A" - Arrival, "D" - Departure
airportArrivalAirportIATA or DepartureAirportIATAarrival_airport_iata, departure_airport_iata
via_airportFlightRouteIATAflight_route_iataIs derived from flightId, multi flight, +++
check_inCheckInDisplayTextcheck_in_display_text
gateGategate_data
gate_statusGateStatusgate_data
beltBaggageClaimUnitbaggage_claim_unit
belt_statusIs derived: BeltLastBag or BeltFirstBagbelt_last_bag or belt_first_bagIf BeltLastBag = C else BeltFirstBag = O
belt_startBeltFirstBagbelt_first_bag
belt_stopBeltLastBagbelt_last_bag
standAircraftParkingPositionArrival or AircraftParkingPositionDepartureaircraft_parking_position_arrival, aircraft_parking_position_departureField type depends on flight direction
est_timeELDT or ETOT or EOBTeldt, etot, eobtELDT for Arrival, for departure If EOBT is set uses it, else ETOT
act_timeALDT or ATOTaldt, atotaldt if arrival, else atot if departure
onb_ofb_timeAIBT or AOBTaibt, aobtaibt if arrival, else aobt if departure
next_infoNextInformationTimenext_information_timeThe dateTime of new info
linked_flightLinkedArrival.FlightId or LinkedDeparture.FlightIdlnk_arv_flight_id, lnk_dep_flight_idif arrival LinkedDeparture.FlightId, else departure LinkedArrival.FlightId
linked_flight_keyNANA
last_delay_codeArrivalDelay or DepartureDelayarrival_delay or departure_delay
last_delay_code2ArrivalDelay or DepartureDelayarrival_delay or departure_delay
cancelled_flagFlightLegStatusflight_leg_statusChecks if flight status is "CANCELED" returns true/false
cdm_eibtEIBTeibt
codeshare_indNANADerived: always 'N'. AltiFlightLeqQuery return data for actual flights and not code shares..
service_typeFlightServiceTypeIATAflight_service_type_iataOne letter IATA service type code e.g. ‘J’ (Schedule passenger) and ‘C’ (Charter passenger). There are no restrictions on service type.
aircraft_typeAircraftIATATypeaircraft_iata_type
aircraft_regAircraftRegistrationaircraft_registration
ramp_fuelFuelRampRequestedfuel_ramp_requested
remark_1RemarkData.RemarkTextflight_leg_remarkIf arrival will display public, if departure will not filter by type
remark_2RemarkData.RemarkTextflight_leg_remarkWill only show staff departure no matter direction
cdm_tobtTOBTtobt
cdm_tsatTSATtsat
airlineOperatingAirlineIataoperating_airline_iata
flight_numberNOT in model (Part of FlightId)NOT in modelIs derived from FlightId
statusNextInformationTime, ALDT, AIBT, ELDT, SIBT, AOBT, ATOT, EOBT, ETOT, SOBTnext_information_time, aldt, aibt, eldt, sibt, aobt, atot, etot, eobt, sobtIf 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 = ’’
delayedNANAIs derived: calculated (ALDT, ELDT, SIBT) for arrival or (AOBT, ETOT, SOBT) for departure.
codeshare_keyNANA
handlingAgentArrivalData.HandlerName or DepartureData.HandlerNamehandler_arrival or handler_departure
handlingAgentCodeArrivalData.HandlerCode or DepartureData.HandlerCodehandler_arrival or handler_departure
flight_leg_keyNANA
gateClosedTimeGateClosegate_dataExample value: 2023-03-14T10:35:12Z
codeshareAirlineDesignatorsNAcode_share
codeshareAirlineNamesCodeshareAirlineIATAcode_share
codeshareFlightNumbersCodeshareFlightNumbercode_share
codeshareOperationalSuffixsNAcode_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).

References

  • No labels