Crew

FL3XX API (1.0.0)

FL3XX API allows partners to access flight information, airport details, and a vast array of aviation services.

Download OpenAPI description
index.json
index.yaml
Overview
URL https://www.fl3xx.com
FL3XX Integration Support integrations@fl3xx.com
License MIT
Languages
Servers
Mock server
https://developer.fl3xx.com/_mock/reference/
Sandbox server
https://test.fl3xx.com/

Accounting

Operations related to accounting.

Operations

Accounts

Operations related accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

Operations related to aircraft.

Operations

Booking Itinerary (Legs)

Operations related to flight itinerary legs.

Operations

Crew

Operations related to crew details.

Operations

Get Crew

Request

Fetches information about the crew.

Query
modifiedSincestring(date-time)

date of last synchronization

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/staff/crew?modifiedSince=2019-08-24T14%3A15%3A22Z' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/jsonArray [
accountobject(AccountDto)
allowancenumber
allowanceDomesticnumber
allowancePaymentSchemastring
Enum"PER_HOUR""PER_LANDING""PER_DAY"
assignmentsArray of objects(AssignmentDto)
birthCountrystring
birthDatestring(date)
birthPlacestring
emailstring
employedSincestring(date-time)
employedUntilstring(date-time)
externalReferencestring
firstNamestring
flightHoursobject(PilotFlightHoursDto)
genderstring
Enum"FEMALE""MALE""OTHER"
homeAirportobject(AirportDto)
idCardsArray of objects(IdcardDto_1)
jobTitlestring
lastNamestring
logNamestring
luggageUnitstring
Enum"KILOGRAM""POUND"
luggageWeightnumber(float)
maxBlockHoursPerMonthinteger(int32)
middleNamestring
mobilestring
nationalitystring
operatorobject(ExternalOperatorBaseDto)
personnelNumberstring
phonestring
pilotIdinteger(int64)
pilotOnAircraftArray of strings
radiationProtectionRegistryIdstring
rolesobject
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
statusstring
Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
trigramstring
userQualificationsArray of objects(UserQualificationDto)
weightnumber(float)
weightUnitstring
Enum"KILOGRAM""POUND"
]
Response
application/json
[
  {
    "account": { … },
    "allowance": 0,
    "allowanceDomestic": 0,
    "allowancePaymentSchema": "PER_HOUR",
    "assignments": [ … ],
    "birthCountry": "string",
    "birthDate": "2019-08-24",
    "birthPlace": "string",
    "email": "string",
    "employedSince": "2019-08-24T14:15:22Z",
    "employedUntil": "2019-08-24T14:15:22Z",
    "externalReference": "string",
    "firstName": "string",
    "flightHours": { … },
    "gender": "FEMALE",
    "homeAirport": { … },
    "idCards": [ … ],
    "jobTitle": "string",
    "lastName": "string",
    "logName": "string",
    "luggageUnit": "KILOGRAM",
    "luggageWeight": 0.1,
    "maxBlockHoursPerMonth": 0,
    "middleName": "string",
    "mobile": "string",
    "nationality": "string",
    "operator": { … },
    "personnelNumber": "string",
    "phone": "string",
    "pilotId": 0,
    "pilotOnAircraft": [ … ],
    "radiationProtectionRegistryId": "string",
    "roles": { … },
    "salutation": "Mr",
    "status": "ACTIVE",
    "trigram": "string",
    "userQualifications": [ … ],
    "weight": 0.1,
    "weightUnit": "KILOGRAM"
  }
]

Get a Crew Member

Request

Fetches crew information using a specific reference.

Path
referencestringrequired

reference

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/staff/crew/{reference}' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
accountobject(AccountDto)
allowancenumber
allowanceDomesticnumber
allowancePaymentSchemastring
Enum"PER_HOUR""PER_LANDING""PER_DAY"
assignmentsArray of objects(AssignmentDto)
birthCountrystring
birthDatestring(date)
birthPlacestring
emailstring
employedSincestring(date-time)
employedUntilstring(date-time)
externalReferencestring
firstNamestring
flightHoursobject(PilotFlightHoursDto)
genderstring
Enum"FEMALE""MALE""OTHER"
homeAirportobject(AirportDto)
idCardsArray of objects(IdcardDto_1)
jobTitlestring
lastNamestring
logNamestring
luggageUnitstring
Enum"KILOGRAM""POUND"
luggageWeightnumber(float)
maxBlockHoursPerMonthinteger(int32)
middleNamestring
mobilestring
nationalitystring
operatorobject(ExternalOperatorBaseDto)
personnelNumberstring
phonestring
pilotIdinteger(int64)
pilotOnAircraftArray of strings
radiationProtectionRegistryIdstring
rolesobject
salutationstring
Enum"Mr""Mrs""Miss""Ms""unDef""Dr""Ing""Prof""Mag""Captain"
statusstring
Enum"ACTIVE""DELETED""INACTIVE""MIGRATED_US"
trigramstring
userQualificationsArray of objects(UserQualificationDto)
weightnumber(float)
weightUnitstring
Enum"KILOGRAM""POUND"
Response
application/json
{
  "account": {
    "accountNumber": 1111,
    "accountid": 1111,
    "email": "email@fl3xx.com",
    "externalReference": "669665849-f120-4f65-6325-11111",
    "internalId": 632123,
    "mobile": 111111111,
    "name": "Account",
    "notes": "Notes",
    "phone": 111111111,
    "vatNumber": "A11111111111",
    "address": { … },
    "links": { … }
  },
  "allowance": 0,
  "allowanceDomestic": 0,
  "allowancePaymentSchema": "PER_HOUR",
  "assignments": [
    { … }
  ],
  "birthCountry": "string",
  "birthDate": "2019-08-24",
  "birthPlace": "string",
  "email": "string",
  "employedSince": "2019-08-24T14:15:22Z",
  "employedUntil": "2019-08-24T14:15:22Z",
  "externalReference": "string",
  "firstName": "string",
  "flightHours": {
    "multiEngine": 0,
    "pic": 0,
    "picMultiEngine": 0,
    "picSingleEngine": 0,
    "singleEngine": 0,
    "total": 0
  },
  "gender": "FEMALE",
  "homeAirport": {
    "aid": "APT-QAPF-UXNM",
    "faa": "null",
    "iata": "null",
    "icao": "OTBD",
    "id": 22024,
    "localIdentifier": "null",
    "name": "Doha International Airport"
  },
  "idCards": [
    { … }
  ],
  "jobTitle": "string",
  "lastName": "string",
  "logName": "string",
  "luggageUnit": "KILOGRAM",
  "luggageWeight": 0.1,
  "maxBlockHoursPerMonth": 0,
  "middleName": "string",
  "mobile": "string",
  "nationality": "string",
  "operator": {
    "id": 0,
    "name": "string"
  },
  "personnelNumber": "string",
  "phone": "string",
  "pilotId": 0,
  "pilotOnAircraft": [
    "string"
  ],
  "radiationProtectionRegistryId": "string",
  "roles": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "salutation": "Mr",
  "status": "ACTIVE",
  "trigram": "string",
  "userQualifications": [
    { … }
  ],
  "weight": 0.1,
  "weightUnit": "KILOGRAM"
}

Search a crew member

Request

Fetches information about the a crew member. Must provide either the externalReference or the piplotId

Query
externalReferencestring

externalReference - E.g from GET /api/external/quote/{id} -> legs[].crew[].externalReference

pilotIdinteger(int64)

pilotId - E.g from GET /api/external/quote/{id} -> legs[].crew[].pilotId

curl -i -X GET \
  'https://developer.fl3xx.com/_mock/reference/api/external/user/crew?externalReference=string&pilotId=0' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
accountobject(AccountDto)
allowancenumber
allowanceDomesticnumber
allowancePaymentSchemastring
Enum"PER_HOUR""PER_LANDING""PER_DAY"
assignmentsArray of objects(AssignmentDto)
birthCountrystring
birthDatestring(date)
birthPlacestring
emailstring
employedSincestring(date-time)
employedUntilstring(date-time)
externalReferencestring
firstNamestring
flightHoursobject(PilotFlightHoursDto)
genderstring
Enum"FEMALE""MALE""OTHER"
homeAirportobject(AirportDto)
idCardsArray of objects(IdcardDto_1)
jobTitlestring
lastNamestring
logNamestring