Flight Leg Details

Summary

Returns flight leg details.

Request

Code snippet: URL

GET /v1/flight_operations/crew_services/COMMON_FLIGHT_LEG_DETAILS

Parameters

Name Type Description Required Schema / Format
flightDesignator Query

IATA flight designator consists of airline code, flight number and suffix (optional).

yes

xsd:string

[A-Z0-9]{2}[0-9]{1,4}[A-Z]?

flightDate Query

Flight date of operation, date of first leg of a flight in UTC.

Defaults to "today" if not provided as a parameter.

xsd:date

[0-9]{4}[-][0-9]{2}[-][0-9]{2}Z

YYYY-MM-DDZ

departureAirport Query

Departure airport IATA code.

If not provided, a Flight Leg Choice Model response may result in case the flightDesignator refers to a multi leg flight.

xsd:string

[A-Z]{3}

arrivalAirport Query

Arrival airport IATA code.

xsd:string

[A-Z]{3}

Responses

Code Description Content-Type Schema
200 The requested flight has been found and its details are returned. application/json Flight Leg Details Model
300 Multiple choices for a multileg flight possible and no specific leg has been requested. application/json Flight Leg Choice Model
404 The requested flight has not been found. application/json Processing Errors Model
500 Any other error application/json Processing Errors Model

Flight Leg Details

Code snippet: Payload

{
  "flightDesignator" → xsd:string
  "operatingAirline" → xsd:string
  "flightDate" → xsd:date
  "departureAirport" → xsd:string
  "arrivalAirport" → xsd:string
  "scheduledTimeOfDeparture" → xsd:dateTime
  "scheduledTimeOfArrival" → xsd:dateTime
  "aircraftRegistration" → xsd:string
  "aircraftSubtype" → xsd:string
  "departureGate" → xsd:string
  "departurePosition" → xsd:string
  "arrivalGate" → xsd:string
  "arrivalPosition" → xsd:string
  "flightTime" → xsd:duration
}
Name Description Required Schema / Format
flightDesignator IATA flight designator consists of airline code, flight number and suffix (optional). yes

xsd:string

[A-Z0-9]{2}[0-9]{1,4}[A-Z]?

operatingAirline

IATA code of the operating airline. yes

xsd:string

[A-Z0-9]{2}

flightDate Flight date of operation, date of first leg of a flight in UTC. yes

xsd:date

[0-9]{4}[-][0-9]{2}[-][0-9]{2}Z

YYYY-MM-DDZ

departureAirport Departure airport IATA code. yes

xsd:string

[A-Z]{3}

arrivalAirport Arrival airport IATA code. yes

xsd:string

[A-Z]{3}

scheduledTimeOfDeparture Scheduled time of departure at UTC time. yes

xsd:dateTime

[0-9]{4}[-][0-9]{2}[-][0-9]{2}T[0-9]{2}[:][0-9]{2}[:][0-9]{2}Z

YYYY-MM-DDTHH:MM:SSZ
scheduledTimeOfArrival Scheduled time of arrival at UTC time. yes

xsd:dateTime

[0-9]{4}[-][0-9]{2}[-][0-9]{2}T[0-9]{2}[:][0-9]{2}[:][0-9]{2}Z

YYYY-MM-DDTHH:MM:SSZ
aircraftRegistration Registration of the aircraft. yes

xsd:string

[A-Z0-9-]{6}

for Lufthansa Germany:

D[-][A-Z]{4}

aircraftSubtype Aircraft subtype. yes xsd:string
departureGate Comma separated list of departure gates. xsd:string

departurePosition

Departure position. xsd:string
arrivalGate Comma separated list of arrival gates. xsd:string
arrivalPosition Arrival position. xsd:string
flightTime Flight time, e.g. PT1H30M for 1 hour and 30 minutes. yes

xsd:period

  • P indicates the period (required)
  • nY indicates the number of years
  • nM indicates the number of months
  • nD indicates the number of days
  • T indicates the start of a time section (required if you are going to specify hours, minutes, or seconds)
  • nH indicates the number of hours
  • nM indicates the number of minutes
  • nS indicates the number of seconds

Flight Leg Choice

Code snippet: Payload

{
    flightLegs → [
        {
            "flightDesignator" → xsd:string
            "flightDate" → xsd:date
            "departureAirport" → xsd:string
            "arrivalAirport" → xsd:string
            "_links" → {
                "flightLegDetails" → {
                    "href" → xsd:anyURI
                }
            }
        },
        {
            ... next matching flight leg ...
        }
    ]
}
Name Description Schema / Format
flightLegs Collection of matching flight legs.
flightLegs[] → flightDesignator IATA flight designator consists of airline code, flight number and suffix (optional).

xsd:string

[A-Z0-9]{2}[0-9]{1,4}[A-Z]?

flightLegs[] → flightDate Flight date of operation, date of first leg of a flight in UTC.

xsd:date

[0-9]{4}[-][0-9]{2}[-][0-9]{2}Z

YYYY-MM-DD Z

flightLegs[] → departureAirport Departure airport IATA code.

xsd:string

[A-Z]{3}

flightLegs[] → arrivalAirport Arrival airport IATA code.

xsd:string

[A-Z]{3}

flightLegs[] → _links Links related to the flight.
flightLegs[] → _links → flightLegDetails Link to flight leg details of the flight.
flightLegs[] → _links → flightLegDetails → href The actual address of the leg details of the flight. xsd:anyURI

Example

Request

Code snippet: URL
/v1/flight_operations/crew_services/COMMON_FLIGHT_LEG_DETAILS?flightDate=2015-01-01Z&flightDesignator=LH400&departureAirport=FRA&arrivalAirport=JFK

Response 200 OK

Code snippet: Payload
{
  "flightDesignator": xsd:string,
  "operatingAirline": xsd:string,
  "flightDate": xsd:date,
  "departureAirport": xsd:string,
  "arrivalAirport": xsd:string,
  "scheduledTimeOfDeparture": xsd:dateTime,
  "scheduledTimeOfArrival": xsd:dateTime,
  "aircraftRegistration": xsd:string,
  "aircraftSubtype": xsd:string,
  "departureGate": xsd:string,
  "departurePosition": xsd:string,
  "arrivalGate": xsd:string,
  "arrivalPosition": xsd:string,
  "flightTime": xsd:duration
}

Response 300 Multiple Choices

Code snippet: Payload
{
    flightLegs: [
        {
            "flightDesignator": xsd:string,
            "flightDate": xsd:date,
            "departureAirport": xsd:string,
            "arrivalAirport": xsd:string,
            "_links": {
                "flightLegDetails": {
                    "href": xsd:anyURI
                }
            }
        },
        {
            ... next matching flight leg ...
        }
    ]
}