Booking Itinerary (Legs)

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

Get Booking Itinerary

Request

Fetches the itinerary (legs) of a booking using its quoteId.

Path
referencestringrequired

reference

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

Responses

Success

Bodyapplication/jsonArray [
aircraftIdinteger(int64)
aircraftTailNumberstring
blockinteger(int32)
cargoUnitstring
Enum"KILOGRAM""POUND"
cmdNamestring
crewMembersinteger(int32)
crewSwapboolean
dailyDutyTimeinteger(int64)
dailyFlightTimeinteger(int64)
datesTBAboolean
distanceinteger(int32)
earliestDeparturestring(date-time)
feasibilityCheckStatusstring
Enum"REQUESTED""APPROVED""DECLINED"
flight24integer(int64)
flightIdinteger(int64)
flightNumberstring
flightNumberSourcestring
Enum"FLO""MANUAL"
flightTimeCalculationResultobject(FlightTimeProviderResult)
flightTimeSourcestring
Enum"FL3XX""AVINODE""ROCKETROUTE""MANUAL""AVIAPAGES"
fromobject(AirportSearchResult)
fuelStopboolean
idinteger(int64)
latestArrivalstring(date-time)
legPriceinteger(int32)
maxCargonumber(float)
maxDutyTimeinteger(int64)
maxFlightTimeinteger(int64)
modificationDatestring(date-time)
modificationUserobject(UserSearchDto)
notesstring
oldLegobject(LegDto)Recursive
operatorWorkflowobject(OperatorWorkflowDto)
originalTaxiTimeArrivalinteger(int32)
originalTaxiTimeDepartureinteger(int32)
otherRejectReasonstring
passengersinteger(int32)
patientsinteger(int32)
posExplainerArray of strings
postFlightLockedboolean
rejectReasonsArray of objects(RejectReasonDto)
reviseFlightboolean
rocketRouteResultobject(FlightTimeProviderResult)
showInDocumentboolean
statusstring
Enum"CANCELED""PENDING""OK""FAILED""WARNING""PENDING_NEW"
taxiTimeArrivalinteger(int32)
taxiTimeDepartureinteger(int32)
techStopboolean
toobject(AirportSearchResult)
typestring
warningsArray of objects(SchedulerWarningDto)
worstStatusstring
Enum"NA""NR""DO""HOLD""REQ""OK""INIT""OK_REVISED""REQ_REVISED""HOLD_REVISED"
]
Response
application/json
[
  {
    "aircraftId": 0,
    "aircraftTailNumber": "string",
    "block": 0,
    "cargoUnit": "KILOGRAM",
    "cmdName": "string",
    "crewMembers": 0,
    "crewSwap": true,
    "dailyDutyTime": 0,
    "dailyFlightTime": 0,
    "datesTBA": true,
    "distance": 0,
    "earliestDeparture": "2019-08-24T14:15:22Z",
    "feasibilityCheckStatus": "REQUESTED",
    "flight24": 0,
    "flightId": 0,
    "flightNumber": "string",
    "flightNumberSource": "FLO",
    "flightTimeCalculationResult": { … },
    "flightTimeSource": "FL3XX",
    "from": { … },
    "fuelStop": true,
    "id": 0,
    "latestArrival": "2019-08-24T14:15:22Z",
    "legPrice": 0,
    "maxCargo": 0.1,
    "maxDutyTime": 0,
    "maxFlightTime": 0,
    "modificationDate": "2019-08-24T14:15:22Z",
    "modificationUser": { … },
    "notes": "string",
    "oldLeg": {},
    "operatorWorkflow": { … },
    "originalTaxiTimeArrival": 0,
    "originalTaxiTimeDeparture": 0,
    "otherRejectReason": "string",
    "passengers": 0,
    "patients": 0,
    "posExplainer": [ … ],
    "postFlightLocked": true,
    "rejectReasons": [ … ],
    "reviseFlight": true,
    "rocketRouteResult": { … },
    "showInDocument": true,
    "status": "CANCELED",
    "taxiTimeArrival": 0,
    "taxiTimeDeparture": 0,
    "techStop": true,
    "to": { … },
    "type": "string",
    "warnings": [ … ],
    "worstStatus": "NA"
  }
]

Submit Booking Itinerary

Request

Submits the itinerary (legs) of a booking using its quoteId.

Path
referencestringrequired

reference

Bodyapplication/json

leg

aircraftstring
arrivalAirportstring
arrivalAirportObjobject(AirportDto)
arrivalDatestring
arrivalDateUTCstring
blockTimeinteger(int32)
commentsstring
crewArray of objects(FlightCrewDto_1)
departureAirportstring
departureAirportObjobject(AirportDto)
departureDatestring
departureDateUTCstring
distancenumber(float)
flightInfoobject(FlightInfo)
flightTimeinteger(int32)
fplTypestring
Enum"N""G""X""M""S"
fuelStopboolean
idstring
notesstring
paxinteger(int32)
planningNotesstring
postFlightClosedboolean
requestedAircraftTypestring
Enum"CJ3""PC12""PC24""PC12/CJ3""PC12/PC24""CHART""SF50"
seatsAfterinteger(int32)
snapshotOfLegIdinteger(int64)
statusstring
Enum"OK""CANCELED"
taskTypestring
Enum"MAINTENANCE""RESERVED""AOG""CREW_UNAVAILABLE""NOTE""FLIGHT""UNSCHEDULED_MAINTENANCE""LOCATION"
techStopboolean
tripNumberinteger(int64)
warningsArray of objects(WarningDto)
workflowstring
Enum"COMMERCIAL""MAINTENANCE""PRIVATE""TRAINING""OWNER""INTERNAL""RESERVED""CHARTER""SUBCHARTER""SCHEDULED"
workflowCustomNamestring
curl -i -X POST \
  'https://developer.fl3xx.com/_mock/reference/api/external/leg/{reference}' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "aircraft": "string",
    "arrivalAirport": "string",
    "arrivalAirportObj": {
      "aid": "APT-QAPF-UXNM",
      "faa": "null",
      "iata": "null",
      "icao": "OTBD",
      "id": 22024,
      "localIdentifier": "null",
      "name": "Doha International Airport"
    },
    "arrivalDate": "string",
    "arrivalDateUTC": "string",
    "blockTime": 0,
    "comments": "string",
    "crew": [
      {
        "crewPosition": {
          "id": 0,
          "role": "CMD",
          "name": "string",
          "code": "string",
          "crewType": "FLIGHT_DECK",
          "disableFtFdpCalculation": true,
          "assignable": true,
          "typeRatingRelated": true
        },
        "email": "string",
        "externalReference": "string",
        "firstName": "string",
        "gender": "FEMALE",
        "isPilotLanding": true,
        "isPilotTakeoff": true,
        "lastName": "string",
        "logName": "string",
        "luggageUnit": "KILOGRAM",
        "luggageWeight": 0.1,
        "middleName": "string",
        "mobile": "string",
        "personnelNumber": "string",
        "phone": "string",
        "pilotId": 0,
        "role": "string",
        "trigram": "string",
        "weight": 0.1,
        "weightUnit": "KILOGRAM"
      }
    ],
    "departureAirport": "string",
    "departureAirportObj": {
      "aid": "APT-QAPF-UXNM",
      "faa": "null",
      "iata": "null",
      "icao": "OTBD",
      "id": 22024,
      "localIdentifier": "null",
      "name": "Doha International Airport"
    },
    "departureDate": "string",
    "departureDateUTC": "string",
    "distance": 0.1,
    "flightInfo": {
      "dossierNumber": "string",
      "flightId": 0,
      "flightType": "CARGO",
      "referenceNumber": "string"
    },
    "flightTime": 0,
    "fplType": "N",
    "fuelStop": true,
    "id": "string",
    "notes": "string",
    "pax": 0,
    "planningNotes": "string",
    "postFlightClosed": true,
    "requestedAircraftType": "CJ3",
    "seatsAfter": 0,
    "snapshotOfLegId": 0,
    "status": "OK",
    "taskType": "MAINTENANCE",
    "techStop": true,
    "tripNumber": 0,
    "warnings": [
      {
        "type": "OK"
      }
    ],
    "workflow": "COMMERCIAL",
    "workflowCustomName": "string"
  }'

Responses

Success

Bodyapplication/json
aircraftIdinteger(int64)
aircraftTailNumberstring
blockinteger(int32)
cargoUnitstring
Enum"KILOGRAM""POUND"
cmdNamestring
crewMembersinteger(int32)
crewSwapboolean
dailyDutyTimeinteger(int64)
dailyFlightTimeinteger(int64)
datesTBAboolean
distanceinteger(int32)
earliestDeparturestring(date-time)
feasibilityCheckStatusstring
Enum"REQUESTED""APPROVED""DECLINED"
flight24integer(int64)
flightIdinteger(int64)
flightNumberstring
flightNumberSourcestring
Enum"FLO""MANUAL"
flightTimeCalculationResultobject(FlightTimeProviderResult)
flightTimeSourcestring
Enum"FL3XX""AVINODE""ROCKETROUTE""MANUAL""AVIAPAGES"
fromobject(AirportSearchResult)
fuelStopboolean
idinteger(int64)
latestArrivalstring(date-time)
legPriceinteger(int32)
maxCargonumber(float)
maxDutyTimeinteger(int64)
maxFlightTimeinteger(int64)
modificationDatestring(date-time)
modificationUserobject(UserSearchDto)
notesstring
oldLegobject(LegDto)Recursive
operatorWorkflowobject(OperatorWorkflowDto)
originalTaxiTimeArrivalinteger(int32)
originalTaxiTimeDepartureinteger(int32)
otherRejectReasonstring
passengersinteger(int32)
patientsinteger(int32)
posExplainerArray of strings