GET /flightstatus

GET /flightstatus

This resource returns a list of operational flights. The list can be refined by giving a set of matching parameters

Request

GET

/flightstatus

headers

key

value

Mandatory/Optional                             Use

Accept

application/hal+json;version=com.afkl.operationalflight.v3

Accept-Language <<language code>> . e.g nl  Optional

To request flight (leg) status translation in different language.

At a time translation is possible in one language.

 parameters

key

explanation

example

Defaults

Optional/Mandatory

startRange

starting from this datetime

2016-09-14T10:00:00Z

Now

Mandatory

endRange

ending on this datetime

2016-09-14T23:59:00Z

Now + 1 hour

Mandatory

movementType

focus (Departure or Arrival) for the flights to be found;

used for selection of departure or arrival time within range

and for deriving local time from arrival or departure station

A = Arrival, D = Departure

D

 D

Optional (for backwards compatibility reasons)

Always set explicitly

timeOriginType

S = Scheduled, M = Modified, I = Internal, P = Public

S

S

Optional (for backwards compatibility reasons)

Always set explicitly

timeType

Type of time used in startRange and endRange

U = UTC time, L = Local Time

U

U

Optional (for backwards compatibility reasons)

Always set explicitly

origin

departure airport

AMS

AMS

Conditional: either origin or destination must be supplied or both

 departureCity IATA departure city code PAR Optional

destination

arrival airport

CDG

 

Conditional: either origin or destination must be supplied or both

 arrivalCity IATA arrival city code LON Optional

carrierCode

airline code (2-pos IATA and 3-pos ICAO)

KL

 

Optional

flightNumber

flightnumber

123

 

Conditional: if used then host (airline code) must also be provided

aircraftRegistration

registration code of the aircraft

PHBEF

Optional

aircraftType

3-position IATA aircraft type code

73W

Optional

pageNumber

The requested page with resultset

1

0

Optional

pageSize

The number of items per page

100

100

Optiona

NOTE:

  1.  Default values are filled only when no input parameters are provided. If there is a parameter provided, then the default values are not taken.

For example: If only the destination station is provided in the request with a start date, then the default value for origin and end date should not filled.

  1. Parameter Operational Suffix is not supported; you can not use the Operational Suffix as search criterion for list of Flights.

Examples

Request urls

 

request with all possible parameters filled:/flights?startRange=2017-08-30T00:00:00Z&endRange=2017-08-30T23:59:59Z&movementType=D&timeOriginType=S&timeType=L&origin=AMS&destination=JFK&carrierCode=KL&flightNumber=0641&operationalSuffix=D&aircraftRegistration=PHABC&aircraftType=777&pageNumber=0&pageSize=10
request for all KL operated and codeshared flights with Local Scheduled Departure date on August 30, flying from AMS to JFK:/flights?startRange=2017-08-30T00:00:00Z&endRange=2017-08-30T23:59:59Z&movementType=D&timeOriginType=S&timeType=L&origin=AMS&destination=JFK&carrierCode=KL
request for all AF operated and codeshared flights with UTC Actual Arrival date on September 1, arriving on CDG:/flights?startRange=2017-09-01T00:00:00Z&endRange=2017-09-01T23:59:59Z&movementType=A&timeOriginType=A&timeType=U&destination=CDG&carrierCode=AF
request for all AF operated and codeshared flights with Local Public Departure date between August 30 and September 30 departing from AMS with flightNumber 0641:/flights?startRange=2017-08-30T00:00:00Z&endRange=2017-09-30T23:59:59Z&movementType=D&timeOriginType=S&timeType=L&origin=AMS&carrierCode=AF&flightNumber=0641
request for all flights with Local Internal Arrival date of August 30 with aircraftRegistration PHABC:/flights?startRange=2017-08-30T00:00:00Z&endRange=2017-08-30T23:59:59Z&movementType=A&timeOriginType=I&timeType=L&aircraftRegistration=PHABC
request for all flights with Local Internal Arrival date of August 30 with aircraftType 777:/flights?startRange=2017-08-30T00:00:00Z&endRange=2017-08-30T23:59:59Z&movementType=A&timeOriginType=I&timeType=L&aircraftType=777

request for all flights with one or more carrier codes

/flights?startRange=2017-08-30T00:00:00Z&endRange=2017-08-30T23:59:59Z&carrierCode=AB, XP, KL, AF, HV, A5, 3S, AM, AZ, JN, DL
                                                OR /flights?startRange=2017-08-30T00:00:00Z&endRange=2017-08-30T23:59:59Z&carrierCode=XP&carrierCode=AB

/flightstatus?startRange=2018-10-27T00:00:00Z&endRange=2018-10-27T10:00:00Z&movementType=D&timeOriginType=S&timeType=L&departureCity=PAR

/flightstatus?startRange=2018-10-27T00:00:00Z&endRange=2018-10-27T10:00:00Z&movementType=D&timeOriginType=S&timeType=L&arrivalCity=LON

/flightstatus?startRange=2018-10-27T00:00:00Z&endRange=2018-10-27T10:00:00Z&movementType=D&timeOriginType=S&timeType=L&origin=AMS&departureCity=PAR

/flightstatus?startRange=2018-10-27T00:00:00Z&endRange=2018-10-27T10:00:00Z&movementType=D&timeOriginType=S&timeType=L&destination=AMS&arrivalCity=PAR

/flightstatus?startRange=2018-10-27T00:00:00Z&endRange=2018-10-27T10:00:00Z&movementType=D&timeOriginType=S&timeType=L&origin=AMS&arrivalCity=PAR

/flightstatus?startRange=2018-10-27T00:00:00Z&endRange=2018-10-27T10:00:00Z&movementType=D&timeOriginType=S&timeType=L&departureCity=PAR&destination=AMS

  

 

Response

 

 
{
  "operationalFlights": [
    {
      "flightNumber"1673,
      "id""20170829+KL+1673",
      "haul""MEDIUM",
      "route": [
        "AMS",
        "BCN"
      ],
      "airline": {
        "code""KL"
      },
      "codeShareRelations": [
        {
          "marketingFlightNumber"7819,
          "type""PASSENGER",
          "airline": {
            "code""AR"
          }
        },
        {
          "marketingFlightNumber"9393,
          "type""PASSENGER",
          "airline": {
            "code""CI"
          }
        }
      ],
      "flightLegs": [
        {
          "status""S",
          "statusName""Scheduled",
          "publishedStatus""ONTIME",
          "departureInformation": {
            "airport": {
              "code""AMS",
              "name""SCHIPHOL AIRPORT",
              "places": {
                "gateNumber": [
                  "C13"
                ],
                "parkingPosition""C13",
                "pierCode""C",
                "boardingPier""C",
                "checkInZone": [
                  "06",
                  "07"
                ]
              }
            },
            "times": {
              "scheduled""2017-08-29T14:15:00.000+02:00",
              "latestPublished""2017-08-29T14:15:00.000+02:00"
            }
          },
          "arrivalInformation": {
            "airport": {
              "code""BCN",
              "name""BARCELONA AIRPORT",
            },
            "times": {
              "scheduled""2017-08-29T16:25:00.000+02:00"
            }
          },
          "scheduledFlightDuration""PT2H10M",
          "aircraft": {
            "registration""PHBXB",
            "typeCode""73H",
            "typeName""Boeing 737-800"
          }
        }
      ]
    },
    {
      "flightNumber"8303,
      "id""20170829+VY+8303",
      "haul""MEDIUM",
      "route": [
        "AMS",
        "BCN"
      ],
      "airline": {
        "code""VY"
      },
      "flightLegs": [
        {
          "status""S",
          "statusName""Scheduled",
          "publishedStatus""ONTIME",
          "departureInformation": {
            "airport": {
              "code""AMS",
              "name""SCHIPHOL AIRPORT",
              "places": {
                "gateNumber": [
                  "D62"
                ],
                "parkingPosition""D04",
                "pierCode""D",
                "boardingPier""D",
                "checkInZone": [
                  "19"
                ]
              }
            },
            "times": {
              "scheduled""2017-08-29T15:10:00.000+02:00",
              "latestPublished""2017-08-29T15:10:00.000+02:00"
            }
          },
          "arrivalInformation": {
            "airport": {
              "code""BCN",
              "name""BARCELONA AIRPORT",
            },
            "times": {
              "scheduled""2017-08-29T15:10:00.000+02:00",
              "latestPublished""2017-08-29T15:10:00.000+02:00"
            }
          },
          "aircraft": {
            "registration""ECLZN",
            "typeCode""320",
            "typeName""Airbus A320"
          }
        }
      ]
    }
  ],
  "page": {
    "pageSize"2,
    "pageNumber"0,
    "fullCount"2,
    "pageCount"2,
    "totalPages"1
  }
}

Specification of the reponse

OFR Response

OFR Error Response

Docs Navigation