• Register

Crew Lists

Summary

Provides information about the crew of a specified flight.

Code snippet: URL

GET v1/flight_operations/crew_services/COMMON_CREWLIST

Parameters

Name Type Description Required Schema / Format
flightDesignator Query

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

The flight number must consist of at least 3 digits, zero-padded for numbers less than 100, e.g. LH001, LH023, LH100, LH1376.

 yes

xsd:string

([0-9][A-Z]|[A-Z][0-9]|[A-Z]{2})([0-9]{3,4})([A-Z]?)
flightDate Query 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 Query Departure airport IATA code. yes

xsd:string

[A-Z]{3}
arrivalAirport Query

Arrival airport IATA code.

 yes

xsd:string

[A-Z]{3}
accessCode Query

Access code for retrieving the crew list.

The access code is provided inside of the complete reference link when retrieving a duty plan.

The link (inclusive the access code) is static and may be reused in future sessions.

 yes xsd:string

Responses

Code Description Content-Type Schema
200 The crew list has been generated as requested. application/json → Crew List Model
401 The requesting person is not on the flight (unauthorized to view the crew list). application/json → Processing Errors Model
403 Access to the crew list is forbidden (e.g. an invalid access code). application/json → Processing Errors Model
404 The requested flight has not been found. application/json → Processing Errors Model
500 Any other error application/json → Processing Errors Model

Crew List

Code snippet: Payload

{
    "flightDesignator" → xsd:string
    "flightDate" → xsd:date
    "departureAirport" → xsd:string
    "arrivalAirport" → xsd:string
    "crewMembers" → [
        {
            "pkNumber" → xsd:string
            "crewPosition" → xsd:string
            "posPrefix" → xsd:string
            "lastName" → xsd:string
            "firstName" → xsd:string
            "courseNumber" → xsd:integer
            "dutyCode" → xsd:string
            "exFlight" → {
                "flightDesignator" → xsd:string
                "flightDate" → xsd:date
                "legSequenceNo" → xsd:integer
                "dutyCode" → xsd:string
            },
            "toFlight" → {
                "flightDesignator" → xsd:string
                "flightDate" → xsd:date
                "legSequenceNo" → xsd:integer
                "dutyCode" → xsd:string
            }
        },
        {
            ... next crew member ...
        }
    ]
}
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]?

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}

crewMembers

 yes

crewMembers[] → pkNumber

 Staff identifier (German: Personalkennziffer) of the person requesting the duty plan. yes

xsd:string

[0-9]{6}[A-Z]

crewMembers[] → crewPosition

 Code for role of the crew member on flight, e.g. CP for captain, PU for purser, etc. similar to BCRL crewlist. yes

xsd:string

crewMembers[] → posPrefix

 # marks QFB qualification xsd:string

crewMembers[] → lastName

 Family name of the crew member (inclusive titles like Von etc.). yes xsd:string

crewMembers[] → firstName

 First name of the crew member. yes xsd:string

crewMembers[] → courseNumber

 Course number (German: Lehrgangsnummer LRGN) or seniority, not shown for purser (P1, P2) or cockpit crew.

xsd:integer
crewMembers[] → dutyCode Indicates that crew member is on duty, dead head, etc. yes

xsd:string

  • "OD" for on-duty
  • "DH" for dead head
  • depending on the backend service, potential other codes are possible

crewMembers[] → exFlight

 The crew member arrives from the specified flight.

crewMembers[] → exFlight → flightDesignator

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

yes

(if exFlight present)

xsd:string

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

crewMembers[] → exFlight → flightDate

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

yes

(if exFlight present)

xsd:date

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

YYYY-MM-DDZ

crewMembers[] → exFlight → legSequenceNo

 Number of the leg in the flight event, where the first leg is denoted as 1.

yes

(if exFlight present)

 xsd:integer

crewMembers[] → exFlight → dutyCode

 Indicates that crew member is on duty, dead head, etc.

yes

(if exFlight present)

xsd:string

yes

see: crewMembers[] → dutyCode

crewMembers[] → toFlight

 The crew member continues with the specified flight.

crewMembers[] → toFlight → flightDesignator

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

yes

(if toFlight present)

xsd:string

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

crewMembers[] → toFlight → flightDate

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

yes

(if toFlight present)

xsd:date

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

YYYY-MM-DDZ

crewMembers[] → toFlight → legSequenceNo

 Number of the leg in the flight event, where the first leg is denoted as 1.

yes

(if toFlight present)

 xsd:integer

crewMembers[] → toFlight → dutyCode

 Indicates that crew member is on duty, dead head, etc.

yes

(if toFlight present)

xsd:string

Info: see crewMembers[] → dutyCode

Example

Request

Code snippet: Get request
GET /v1/flight_operations/crew_services/COMMON_CREWLIST?flightDesignator=LH400&flightDate=2015-01-01Z&departureAirport=FRA&arrivalAirport=JFK&accessCode=xh5nFs

Response

Code snippet: Json
{
  "flightDesignator": "LH716",
  "flightDate": "2016-11-07Z",
  "departureAirport": "FRA",
  "arrivalAirport": "HND",
  "crewMembers": [
    {
      "pkNumber": "144470D",
      "crewPosition": "CP",
      "posPrefix": "",
      "lastName": "BUSS",
      "firstName": "CLAUS-DIETER",
      "courseNumber": 0,
      "dutyCode": "OD",
      "exFlight": null,
      "toFlight": {
        "flightDesignator": "LH717",
        "flightDate": "2016-11-10Z",
        "legSequenceNo": 1,
        "dutyCode": "OD"
      },
    },
    {
      "pkNumber": "064002K",
      "crewPosition": "SF",
      "posPrefix": "",
      "lastName": "STEUDER",
      "firstName": "JUERGEN",
      "courseNumber": 0,
      "dutyCode": "OD",
      "exFlight": null,
      "toFlight": {
        "flightDesignator": "LH717",
        "flightDate": "2016-11-10Z",
        "legSequenceNo": 1,
        "dutyCode": "OD"
      }
    },
    {
      "pkNumber": "951036H",
      "crewPosition": "FO",
      "posPrefix": "",
      "lastName": "SCHANZ",
      "firstName": "CHRISTIAN",
      "courseNumber": 0,
      "dutyCode": "OD",
      "exFlight": null,
      "toFlight": {
        "flightDesignator": "LH717",
        "flightDate": "2016-11-10Z",
        "legSequenceNo": 1,
        "dutyCode": "OD"
      }
    },
    ...
  ]
}

version 8 as of 7 years ago by Matthias

Docs Navigation