Skip to content
/
Submit Flight PAX Informa...

FL3XX API (1.8.0)

Platform Overview

The FL3XX API provides seamless access to a comprehensive suite of aviation services, enabling partners to integrate and manage flight information, airport details, and operational functionalities. Built with performance and reliability in mind, our API serves as the foundation for your aviation technology infrastructure.

Flight Information

Access detailed flight data, including schedules, crew assignments, passenger details, and real-time updates.

Airport Management

Retrieve information about airports, including ground services, fuel availability, and operational notes.

Fleet Operations

Manage aircraft assets, maintenance schedules, and operational fleet utilization.

Quotes & Bookings

Create, update, and manage quotes and bookings with flexible pricing and multi-sector support.

Financial Operations

Handle invoicing, payments, financial reporting, and integrated accounting workflows.

Document Management

Handle document processing, categorization, and seamless workflow integration.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://www.fl3xx.com
FL3XX Integration Support
integrations@fl3xx.com
License
MIT
Languages
Servers
Test Server
https://test.fl3xx.com/

Accounting

This group of endpoints is designed to manage accounting operations such as invoice management, payment processing, and general ledger entries. These endpoints are essential for ensuring accurate financial records and efficient financial operations.

Key Features

  • Invoice Management: Create, retrieve, and update invoices.
  • Payment Processing: Handle payment transactions and manage payment records.
  • General Ledger: Access and update general ledger entries for comprehensive financial tracking.

Business Value

  • Financial Accuracy: Ensures accurate and up-to-date financial records, minimizing errors and discrepancies.
  • Operational Efficiency: Streamlines financial operations, reducing the time and effort required to manage accounting tasks.
  • Compliance: Helps meet regulatory requirements by maintaining detailed and accurate financial records.

Use Cases

  • Financial Management: Efficiently manage financial transactions and records, ensuring all financial data is current and accurate.
  • Audit Preparation: Maintain detailed financial records to facilitate audit processes and ensure compliance.
  • Budgeting and Forecasting: Use financial data to create budgets and forecast future financial performance.

Why Use These Endpoints

Utilizing the endpoints under the Accounting tag helps to streamline financial operations by ensuring data integrity and accuracy. They are essential tools for maintaining financial health and compliance within the organization.

Operations

Accounts

Operations related to accounts.

Operations

Airports

Access and manage airport information.

Operations

Aircraft

This group of endpoints is designed to manage aircraft details, maintenance schedules, and pricing information. These endpoints are essential for ensuring the efficient operation and management of aircraft within the aviation industry.

Key Features

  • Details Management: Access and update detailed information about aircraft, including specifications and configurations.
  • Maintenance: Manage maintenance schedules and records to ensure aircraft are in optimal condition.
  • Pricing: Retrieve and update pricing information for aircraft operations and services.

Business Value

  • Operational Efficiency: Streamlines the management of aircraft details and maintenance, reducing downtime and operational disruptions.
  • Cost Management: Provides accurate and up-to-date pricing information, aiding in financial planning and cost control.
  • Compliance: Ensures that maintenance schedules and records are up-to-date, helping to meet regulatory requirements.

Use Cases

  • Fleet Management: Efficiently manage a fleet of aircraft, ensuring all details and maintenance records are current.
  • Maintenance Planning: Schedule and track maintenance activities to minimize aircraft downtime and ensure safety.
  • Financial Planning: Use pricing information to forecast operational costs and manage budgets effectively.

Why Use These Endpoints

Utilizing the endpoints under the Aircraft tag helps to streamline the management of aircraft operations by ensuring data integrity and accuracy. They are essential tools for maintaining operational efficiency and compliance within the aviation industry.

Operations

Booking Itinerary (Legs)

Operations related to flight itinerary legs.

Operations

Crew

Operations related to crew details.

Operations

Crew Qualifications

Manage crew qualifications and certifications. These endpoints enable partners to assign, update, and manage crew member qualifications including licenses, certifications, and associated documents.

Business Value

  • Maintain accurate crew qualification records for compliance and safety.
  • Streamline qualification assignment and management processes.
  • Support document management for qualification certificates and licenses.
  • Ensure crew members meet operational requirements and regulations.

Use Cases

  • Assign new qualifications to crew members with license details and expiration dates.
  • Update existing qualification information including license numbers and issuing authorities.
  • Upload and manage qualification documents such as certificates and licenses.
  • Retrieve qualification information for crew members and compliance reporting.
  • Delete obsolete qualifications and associated documents.

For more information on managing crew qualifications, see the Crew Qualification Management Guide.

Note:

All crew qualification operations are bound to the operator context associated with the authentication token. Partners can only manage qualifications for crew members within their organization.

Operations

Staff

Create and update staff members and their ID document files.

Operations

Empty Legs

Operations related to empty leg flights.

Operations

Flights

Operations related to flights.

Operations

New Flights

The quote book and confirm endpoints, also listed under the Flights collection. They are the same operations as in Quotes and live under /api/external/quote/book and /api/external/quote/confirm.

Operations

Flight Animals

Operations related to flight animals.

Operations

Flight Cargo

Operations related to flight cargo.

Operations

Flight Crew

Operations related to crew for individual flights.

Operations

Flight Alternate Airports

Operations related to the alternate airports of a flight.

Operations

Flight Defects

Operations related to the defects of a flight.

Operations

Flight Fuels

Operations related to fuel for flights.

Operations

Flight Ground Services

Operations related to ground services.

Operations

Flight Luggage

Operations related to luggage for flights.

Operations

Flight Migration

Operations related to migrations.

Operations

Flight Notifications

Operations related to notifications for flights.

Operations

Flight Passengers

These endpoints are designed to manage passenger details for flights. They allow for the retrieval, updating, and deletion of passenger information associated with specific flight tickets.

Key Features

  • Passenger Management: Add, retrieve, update, and delete passenger details for flights.
  • Data Accuracy: Ensures that passenger information is accurate and up-to-date.

Business Value

  • Operational Efficiency: Streamlines the process of managing passenger information, reducing manual effort.
  • Customer Service: Enhances the ability to provide timely and accurate information to passengers and stakeholders.
  • Compliance: Helps maintain accurate records of passenger details for regulatory and operational purposes.

Use Cases

  • Flight Operations: Quickly access and manage passenger details for flight management and operations.
  • Customer Support: Assist passengers with inquiries about their flight details and ticket information.
  • Regulatory Compliance: Maintain accurate and up-to-date passenger records for each flight.
Operations

Flight PAX Details

Operations related to PAX details.

Operations

Get Flight PAX Information

Request

Fetches animal and cargo information for a specific flight using its flight ID.

Security
API_AUTHENTICATION
Path
idinteger(int64)required

id

curl -i -X GET \
  'https://test.fl3xx.com/api/external/flight/{id}/pax_details' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
activeNoFlyListsArray of objects(NoFlyListUploadMinDto)
aircraftIdinteger(int64)
animalArray of objects(AnimalDto)
bookingstring
bookingIdinteger(int64)
cargoArray of objects(CargoDto)
cargoAllowedboolean
crewBriefobject(CrewBriefDto)
flightstring
flightIdinteger(int64)
mtowUnitstring
Enum"KILOGRAM""POUND"
paxobject(PaxDto)
petsAllowedboolean
reducedRestEnabledboolean
tailNumberstring
tsaobject(TsaFlightDetails)
Response
application/json
{
  "activeNoFlyLists": [
    { … }
  ],
  "aircraftId": 0,
  "animal": [
    { … }
  ],
  "booking": "string",
  "bookingId": 0,
  "cargo": [
    { … }
  ],
  "cargoAllowed": true,
  "crewBrief": {
    "by": "HANDLER",
    "crewNotes": "string",
    "flightSelection": { … },
    "id": 0,
    "permitProviderId": 0,
    "status": "NA"
  },
  "flight": "string",
  "flightId": 0,
  "mtowUnit": "KILOGRAM",
  "pax": {
    "by": "HANDLER",
    "id": 0,
    "paxCount": 0,
    "permitProviderId": 0,
    "status": "NA",
    "tickets": [ … ]
  },
  "petsAllowed": true,
  "reducedRestEnabled": true,
  "tailNumber": "string",
  "tsa": {
    "blockedUntil": 0,
    "changes": { … },
    "date": "2019-08-24T14:15:22Z",
    "disabledReason": "NOT_TSA_APPLICABLE",
    "enabledForFlight": true,
    "hasChanges": true,
    "lastMessageType": "string",
    "note": "string",
    "tsaPendingResponse": true,
    "tsaSendDate": "2019-08-24T14:15:22Z"
  }
}

Submit Flight PAX Information

Request

Submits animal and cargo information for a specific flight using its flight ID.

Security
API_AUTHENTICATION
Path
idinteger(int64)required

id

Bodyapplication/jsonrequired

dto

activeNoFlyListsArray of objects(NoFlyListUploadMinDto)
aircraftIdinteger(int64)
animalArray of objects(AnimalDto_1)
bookingstring
bookingIdinteger(int64)
cargoArray of objects(CargoDto_1)
cargoAllowedboolean
crewBriefobject(CrewBriefDto_1)
flightstring
flightIdinteger(int64)
mtowUnitstring
Enum"KILOGRAM""POUND"
paxobject(PaxDto_1)
petsAllowedboolean
reducedRestEnabledboolean
tailNumberstring
tsaobject(TsaFlightDetails_1)
curl -i -X POST \
  'https://test.fl3xx.com/api/external/flight/{id}/pax_details' \
  -H 'Content-Type: application/json' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE' \
  -d '{
    "activeNoFlyLists": [
      {
        "active": true,
        "entryType": "NoFly",
        "fileName": "string",
        "fileSize": 0,
        "id": 0
      }
    ],
    "aircraftId": 0,
    "animal": [
      {
        "cargoType": "ACT",
        "documents": [
          {
            "creationDate": "2019-08-24T14:15:22Z",
            "customName": "string",
            "entityName": "string",
            "fileSize": 0,
            "id": 0,
            "imageSizeX": 0,
            "imageSizeY": 0,
            "isThumbnail": true,
            "name": "string",
            "originalName": "string",
            "refEntityId": 0,
            "status": "string",
            "thumbnail": {},
            "uuid": "string"
          }
        ],
        "id": 0,
        "note": "string",
        "packages": 0,
        "type": "DOG",
        "weight": "string",
        "weightQty": 0.1,
        "weightUnit": "KILOGRAM"
      }
    ],
    "booking": "string",
    "bookingId": 0,
    "cargo": [
      {
        "cargoType": "ACT",
        "documents": [
          {
            "creationDate": "2019-08-24T14:15:22Z",
            "customName": "string",
            "entityName": "string",
            "fileSize": 0,
            "id": 0,
            "imageSizeX": 0,
            "imageSizeY": 0,
            "isThumbnail": true,
            "name": "string",
            "originalName": "string",
            "refEntityId": 0,
            "status": "string",
            "thumbnail": {},
            "uuid": "string"
          }
        ],
        "id": 0,
        "note": "string",
        "packages": 0,
        "weight": "string",
        "weightQty": 0.1,
        "weightUnit": "KILOGRAM"
      }
    ],
    "cargoAllowed": true,
    "crewBrief": {
      "by": "HANDLER",
      "crewNotes": "string",
      "flightSelection": {
        "bookings": [
          {
            "aircraftId": 0,
            "avinodeAccepted": true,
            "bookingIdentifier": "string",
            "color": "string",
            "creationDate": "2019-08-24T14:15:22Z",
            "currency": "string",
            "customerInfo": {
              "account": {
                "accountNumber": "string",
                "id": 0,
                "name": "string",
                "operator": {},
                "status": "ACTIVE"
              },
              "accountCommercialComment": "string",
              "accountCustomFields": [
                {}
              ],
              "changedManually": true,
              "commercialPreferences": [
                {}
              ],
              "firstName": "string",
              "id": 0,
              "lastName": "string",
              "nickname": "string",
              "userCommercialComment": "string"
            },
            "defaultCurrency": "string",
            "displayPrice": 0,
            "externalOperator": "string",
            "hasChildren": true,
            "id": 0,
            "integrations": [
              "string"
            ],
            "legInfo": {
              "date": "2019-08-24T14:15:22Z",
              "duration": "string",
              "flightNumber": "string",
              "flightSequence": "string",
              "from": "string",
              "fromId": 0,
              "fromTimeZone": "string",
              "legId": 0,
              "to": "string",
              "toId": 0
            },
            "operator": {
              "id": 0,
              "name": "string"
            },
            "operatorWorkflow": {
              "cargo": true,
              "deleted": true,
              "fplType": "N",
              "hidden": true,
              "id": 0,
              "name": "string",
              "nature": 0,
              "operationType": {
                "id": 0,
                "label": "string"
              },
              "operatorId": 0,
              "order": 0,
              "useFlightReleaseProcess": true,
              "workflow": "string"
            },
            "origin": "string",
            "rootId": 0,
            "salesInfo": {
              "account": {
                "accountNumber": "string",
                "id": 0,
                "name": "string",
                "operator": {},
                "status": "ACTIVE"
              },
              "changedManually": true,
              "firstName": "string",
              "id": 0,
              "lastName": "string",
              "nickname": "string"
            },
            "sourcingBookingReference": "string",
            "statusSymbol": "string",
            "tags": [
              {
                "color": "string",
                "deleted": true,
                "id": 0,
                "name": "string",
                "order": 0
              }
            ],
            "tailNum": "string",
            "totalAvinodeNotificationsCount": 0,
            "totalNotificationsCount": 0,
            "unseenAvinodeNotificationsCount": 0,
            "unseenNotificationsCount": 0,
            "validUntil": "2019-08-24T14:15:22Z",
            "versionDetails": {
              "accepted": 0,
              "color": "string",
              "declined": 0,
              "id": 0,
              "notAnswered": 0,
              "statusSymbol": "string",
              "unreadMessages": 0
            }
          }
        ],
        "flightSelection": [
          {
            "flight": {
              "acknowledgementDate": "2019-08-24T14:15:22Z",
              "aircraftId": 0,
              "aircraftReqRw": 0.1,
              "aircraftType": "string",
              "aoc": "string",
              "aocId": 0,
              "arrAirport": {
                "airportElevation": 0.1,
                "airportid": 0,
                "alternates": [
                  null
                ],
                "category": "A",
                "countryIso2": "string",
                "danger": true,
                "faa": "string",
                "handler": {},
                "iata": "string",
                "icao": "string",
                "latitude": 0.1,
                "localIdentifier": "string",
                "longestRunwayLength": 0.1,
                "longitude": 0.1,
                "name": "string",
                "pilotQualification": true,
                "requestedHandler": {},
                "rescueAndFireFightingCategory": "A_1",
                "servedCity": "string",
                "timeZone": "string",
                "warning": true,
                "widestRunwayWidth": 0.1
              },
              "arrDate": "2019-08-24T14:15:22Z",
              "bookingId": 0,
              "bookingIdentifier": "string",
              "bookingNotes": "string",
              "buyerFirstName": "string",
              "buyerLastName": "string",
              "cancelled": true,
              "cfmuCalcTakeOff": "2019-08-24T14:15:22Z",
              "crewNotes": "string",
              "crewTime": {
                "blocksOff": "2019-08-24T14:15:22Z",
                "blocksOn": "2019-08-24T14:15:22Z",
                "checkIn": "2019-08-24T14:15:22Z",
                "checkOut": "2019-08-24T14:15:22Z",
                "landing": "2019-08-24T14:15:22Z",
                "status": "NA",
                "takeOff": "2019-08-24T14:15:22Z"
              },
              "crewWarningsSummary": {
                "fdWarnings": true,
                "ccWarnings": true,
                "usersWithWarnings": [
                  null
                ]
              },
              "customerAccountNumber": "string",
              "customerId": 0,
              "customerName": "string",
              "depAirport": {
                "airportElevation": 0.1,
                "airportid": 0,
                "alternates": [
                  null
                ],
                "category": "A",
                "countryIso2": "string",
                "danger": true,
                "faa": "string",
                "handler": {},
                "iata": "string",
                "icao": "string",
                "latitude": 0.1,
                "localIdentifier": "string",
                "longestRunwayLength": 0.1,
                "longitude": 0.1,
                "name": "string",
                "pilotQualification": true,
                "requestedHandler": {},
                "rescueAndFireFightingCategory": "A_1",
                "servedCity": "string",
                "timeZone": "string",
                "warning": true,
                "widestRunwayWidth": 0.1
              },
              "depDate": "2019-08-24T14:15:22Z",
              "details": {
                "crw": {},
                "flightRelease": {},
                "flt": {},
                "hndlgAndSvcs": {},
                "id": 0,
                "log": {},
                "notif": {},
                "nts": {}
              },
              "detailsArrival": {
                "crw": {},
                "flightRelease": {},
                "flt": {},
                "hndlgAndSvcs": {},
                "id": 0,
                "log": {},
                "notif": {},
                "nts": {}
              },
              "distanceFromToKm": 0,
              "externalNotes": "string",
              "feasibilityCheckStatus": "REQUESTED",
              "ffCat": "A_1",
              "flightDetails": {
                "additionalCrew": [
                  null
                ],
                "arr": {},
                "blocksOff": "2019-08-24T14:15:22Z",
                "blocksOffDefault": "2019-08-24T14:15:22Z",
                "blocksOn": "2019-08-24T14:15:22Z",
                "blocksOnDefault": "2019-08-24T14:15:22Z",
                "ca": [
                  null
                ],
                "cargo": 0.1,
                "catering": "string",
                "cmd": {},
                "dep": {},
                "emptySeats": {},
                "etaDefault": "2019-08-24T14:15:22Z",
                "fa": [
                  null
                ],
                "fo": {},
                "fpl": "N",
                "fuelUnit": "LITER",
                "hilNumber": 0,
                "landing": "2019-08-24T14:15:22Z",
                "landingDefault": "2019-08-24T14:15:22Z",
                "maintananceCount": 0,
                "maintananceExpired": 0,
                "numberOfPax": 0,
                "onBoardEngineers": [
                  null
                ],
                "pax": [
                  null
                ],
                "takeOff": "2019-08-24T14:15:22Z",
                "takeOffDefault": "2019-08-24T14:15:22Z",
                "techlogNumber": "string",
                "totalLandings": 0,
                "wAndB": true
              },
              "flightNumber": "string",
              "flightNumberSource": "FLO",
              "flightType": "string",
              "id": 0,
              "landing": "2019-08-24T14:15:22Z",
              "maxCargo": 0.1,
              "modificationDate": "2019-08-24T14:15:22Z",
              "modificationUser": {
                "accountName": "string",
                "firstName": "string",
                "gender": "FEMALE",
                "height": 0.1,
                "id": 0,
                "jobTitle": "string",
                "lastName": "string",
                "middleName": "string",
                "nationalityCountryName": "string",
                "nickname": "string",
                "personnelNumber": "string",
                "pilot": true,
                "status": "ACTIVE",
                "userCharacteristics": {},
                "weight": 0.1
              },
              "mvtBlocksOffEst": "2019-08-24T14:15:22Z",
              "mvtBlocksOnEst": "2019-08-24T14:15:22Z",
              "notes": "string",
              "oldLeg": {
                "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": {
                  "warnings": [],
                  "errors": []
                },
                "flightTimeSource": "FL3XX",
                "from": {},
                "fuelStop": true,
                "id": 0,
                "latestArrival": "2019-08-24T14:15:22Z",
                "legPrice": 0,
                "maxCargo": 0.1,
                "modificationDate": "2019-08-24T14:15:22Z",
                "modificationUser": {},
                "notes": "string",
                "oldLeg": {},
                "operatorWorkflow": {},
                "originalTaxiTimeArrival": 0,
                "originalTaxiTimeDeparture": 0,
                "otherRejectReason": "string",
                "passengers": 0,
                "patients": 0,
                "posExplainer": [
                  null
                ],
                "postFlightLocked": true,
                "rejectReasons": [
                  null
                ],
                "reviseFlight": true,
                "showInDocument": true,
                "status": "CANCELED",
                "taxiTimeArrival": 0,
                "taxiTimeDeparture": 0,
                "techStop": true,
                "to": {},
                "type": "string",
                "warnings": [
                  null
                ],
                "worstStatus": "NA"
              },
              "operator": {
                "id": 0,
                "name": "string"
              },
              "operatorWorkflow": {
                "cargo": true,
                "deleted": true,
                "fplType": "N",
                "hidden": true,
                "id": 0,
                "name": "string",
                "nature": 0,
                "operationType": {},
                "operatorId": 0,
                "order": 0,
                "useFlightReleaseProcess": true,
                "workflow": "string"
              },
              "opsTeamIds": [
                0
              ],
              "passengers": 0,
              "passengersActual": 0,
              "paymentGuarantee": "NOT_GUARANTEED",
              "paymentStatus": "NOT_PAID",
              "planningNotes": "string",
              "readFromCrewApp": "2019-08-24T14:15:22Z",
              "revisionUser": {
                "accountName": "string",
                "firstName": "string",
                "gender": "FEMALE",
                "height": 0.1,
                "id": 0,
                "jobTitle": "string",
                "lastName": "string",
                "middleName": "string",
                "nationalityCountryName": "string",
                "nickname": "string",
                "personnelNumber": "string",
                "pilot": true,
                "status": "ACTIVE",
                "userCharacteristics": {},
                "weight": 0.1
              },
              "serviceCancellationRequired": true,
              "serviceCostBookingStatus": "OPEN",
              "setup": true,
              "tailNumber": "string",
              "takeOff": "2019-08-24T14:15:22Z",
              "tripNumber": 0,
              "unseenNotificationsByConversationType": {
                "property1": 0,
                "property2": 0
              },
              "unseenNotificationsCount": 0,
              "warnings": [
                {}
              ],
              "workflow": "COMMERCIAL",
              "worstStatus": "NA"
            },
            "selected": true
          }
        ]
      },
      "id": 0,
      "permitProviderId": 0,
      "status": "NA"
    },
    "flight": "string",
    "flightId": 0,
    "mtowUnit": "KILOGRAM",
    "pax": {
      "by": "HANDLER",
      "id": 0,
      "paxCount": 0,
      "permitProviderId": 0,
      "status": "NA",
      "tickets": [
        {
          "blocksOffEstimated": "2019-08-24T14:15:22Z",
          "blocksOnEstimated": "2019-08-24T14:15:22Z",
          "checkInStatus": "NOT_CHECKED_IN",
          "comment": "string",
          "created": "2019-08-24T14:15:22Z",
          "departureAddress": {
            "buildingDetails": "string",
            "city": "string",
            "country": {
              "capital": "string",
              "continent": "string",
              "currencyCode": "string",
              "domain": "string",
              "id": 0,
              "intname": "string",
              "ioc": "string",
              "iso2": "string",
              "iso3": "string",
              "name": "string",
              "phone": "string"
            },
            "countryId": 0,
            "defaultAddress": true,
            "id": 0,
            "latitude": 0.1,
            "longitude": 0.1,
            "modificationDate": "2019-08-24T14:15:22Z",
            "recipient": "string",
            "state": "string",
            "street": "string",
            "type": "WORK",
            "zip": "string"
          },
          "destinationAddress": {
            "buildingDetails": "string",
            "city": "string",
            "country": {
              "capital": "string",
              "continent": "string",
              "currencyCode": "string",
              "domain": "string",
              "id": 0,
              "intname": "string",
              "ioc": "string",
              "iso2": "string",
              "iso3": "string",
              "name": "string",
              "phone": "string"
            },
            "countryId": 0,
            "defaultAddress": true,
            "id": 0,
            "latitude": 0.1,
            "longitude": 0.1,
            "modificationDate": "2019-08-24T14:15:22Z",
            "recipient": "string",
            "state": "string",
            "street": "string",
            "type": "WORK",
            "zip": "string"
          },
          "externalReference": "string",
          "id": 0,
          "idCard": {
            "copy": {
              "creationDate": "2019-08-24T14:15:22Z",
              "customName": "string",
              "entityName": "string",
              "fileSize": 0,
              "id": 0,
              "imageSizeX": 0,
              "imageSizeY": 0,
              "isThumbnail": true,
              "name": "string",
              "originalName": "string",
              "refEntityId": 0,
              "status": "string",
              "thumbnail": {},
              "uuid": "string"
            },
            "deleted": true,
            "expirationDate": "2019-08-24T14:15:22Z",
            "id": 0,
            "issueAuthority": "string",
            "issueCountry": {
              "capital": "string",
              "continent": "string",
              "currencyCode": "string",
              "domain": "string",
              "id": 0,
              "intname": "string",
              "ioc": "string",
              "iso2": "string",
              "iso3": "string",
              "name": "string",
              "phone": "string"
            },
            "issueCountryId": 0,
            "issueDate": "2019-08-24T14:15:22Z",
            "issuePlace": "string",
            "lastMailSent": "2019-08-24T14:15:22Z",
            "main": true,
            "number": "string",
            "passportId": 0,
            "state": "string",
            "type": "PASSPORT",
            "userId": 0,
            "visaType": "string"
          },
          "idCardArrival": {
            "copy": {
              "creationDate": "2019-08-24T14:15:22Z",
              "customName": "string",
              "entityName": "string",
              "fileSize": 0,
              "id": 0,
              "imageSizeX": 0,
              "imageSizeY": 0,
              "isThumbnail": true,
              "name": "string",
              "originalName": "string",
              "refEntityId": 0,
              "status": "string",
              "thumbnail": {},
              "uuid": "string"
            },
            "deleted": true,
            "expirationDate": "2019-08-24T14:15:22Z",
            "id": 0,
            "issueAuthority": "string",
            "issueCountry": {
              "capital": "string",
              "continent": "string",
              "currencyCode": "string",
              "domain": "string",
              "id": 0,
              "intname": "string",
              "ioc": "string",
              "iso2": "string",
              "iso3": "string",
              "name": "string",
              "phone": "string"
            },
            "issueCountryId": 0,
            "issueDate": "2019-08-24T14:15:22Z",
            "issuePlace": "string",
            "lastMailSent": "2019-08-24T14:15:22Z",
            "main": true,
            "number": "string",
            "passportId": 0,
            "state": "string",
            "type": "PASSPORT",
            "userId": 0,
            "visaType": "string"
          },
          "luggageWeight": 0.1,
          "main": true,
          "noDOBwarning": true,
          "okForBoarding": true,
          "patient": true,
          "paxType": "NONE",
          "paxUser": {
            "accountName": "string",
            "birthDate": "2019-08-24T14:15:22Z",
            "birthPlace": "string",
            "catering": "string",
            "emailAddress": "string",
            "firstName": "string",
            "gender": "FEMALE",
            "height": 0.1,
            "id": 0,
            "idsCount": 0,
            "important": "string",
            "interest": "string",
            "jobTitle": "string",
            "lastName": "string",
            "middleName": "string",
            "nationalityCountryName": "string",
            "nickname": "string",
            "personnelNumber": "string",
            "phoneNumber": "string",
            "pilot": true,
            "preferences": [
              {
                "template": {},
                "description": "string"
              }
            ],
            "salutation": "Mr",
            "status": "ACTIVE",
            "userCharacteristics": {
              "defaultLuggageWeight": 0.1,
              "eyeColor": "string",
              "hairColor": "string"
            },
            "vaccinations": [
              {
                "copy": {},
                "deleted": true,
                "id": 0,
                "protectedUntil": "2019-08-24T14:15:22Z",
                "type": "CHOLERA",
                "userId": 0,
                "vaccinationDate": "2019-08-24T14:15:22Z"
              }
            ],
            "weight": 0.1
          },
          "sanctionList": "GRAY",
          "sanctionListNote": "string",
          "seatOnLap": true,
          "sifl": "BUSINESS",
          "source": "WEBAPP",
          "status": "CANCELED",
          "ticketNumber": "string",
          "ticketid": 0,
          "tsaCleared": true,
          "tsaClearedBy": {
            "accountName": "string",
            "firstName": "string",
            "gender": "FEMALE",
            "height": 0.1,
            "id": 0,
            "jobTitle": "string",
            "lastName": "string",
            "middleName": "string",
            "nationalityCountryName": "string",
            "nickname": "string",
            "personnelNumber": "string",
            "pilot": true,
            "status": "ACTIVE",
            "userCharacteristics": {
              "defaultLuggageWeight": 0.1,
              "eyeColor": "string",
              "hairColor": "string"
            },
            "weight": 0.1
          },
          "tsaClearedDate": "2019-08-24T14:15:22Z",
          "tsaDate": "2019-08-24T14:15:22Z",
          "tsaListMatches": {
            "property1": [
              {
                "importFile": "string",
                "line": 0
              }
            ],
            "property2": [
              {
                "importFile": "string",
                "line": 0
              }
            ]
          },
          "tsaNote": "string",
          "tsaPendingResponse": true,
          "tsaSendDate": "2019-08-24T14:15:22Z",
          "tsaStatus": "GRAY",
          "type": "PAX",
          "visa": "GRAY",
          "visaNote": "string"
        }
      ]
    },
    "petsAllowed": true,
    "reducedRestEnabled": true,
    "tailNumber": "string",
    "tsa": {
      "blockedUntil": 0,
      "changes": {
        "flightDataChanged": true,
        "flightDoesNotApply": true,
        "paxChanges": {
          "added": [
            0
          ],
          "updated": [
            0
          ],
          "same": [
            0
          ],
          "cancelled": [
            0
          ]
        }
      },
      "date": "2019-08-24T14:15:22Z",
      "disabledReason": "NOT_TSA_APPLICABLE",
      "enabledForFlight": true,
      "hasChanges": true,
      "lastMessageType": "string",
      "note": "string",
      "tsaPendingResponse": true,
      "tsaSendDate": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Success

Bodyapplication/json
activeNoFlyListsArray of objects(NoFlyListUploadMinDto)
aircraftIdinteger(int64)
animalArray of objects(AnimalDto)
bookingstring
bookingIdinteger(int64)
cargoArray of objects(CargoDto)
cargoAllowedboolean
crewBriefobject(CrewBriefDto)
flightstring
flightIdinteger(int64)
mtowUnitstring
Enum"KILOGRAM""POUND"
paxobject(PaxDto)
petsAllowedboolean
reducedRestEnabledboolean
tailNumberstring
tsaobject(TsaFlightDetails)
Response
application/json
{
  "activeNoFlyLists": [
    { … }
  ],
  "aircraftId": 0,
  "animal": [
    { … }
  ],
  "booking": "string",
  "bookingId": 0,
  "cargo": [
    { … }
  ],
  "cargoAllowed": true,
  "crewBrief": {
    "by": "HANDLER",
    "crewNotes": "string",
    "flightSelection": { … },
    "id": 0,
    "permitProviderId": 0,
    "status": "NA"
  },
  "flight": "string",
  "flightId": 0,
  "mtowUnit": "KILOGRAM",
  "pax": {
    "by": "HANDLER",
    "id": 0,
    "paxCount": 0,
    "permitProviderId": 0,
    "status": "NA",
    "tickets": [ … ]
  },
  "petsAllowed": true,
  "reducedRestEnabled": true,
  "tailNumber": "string",
  "tsa": {
    "blockedUntil": 0,
    "changes": { … },
    "date": "2019-08-24T14:15:22Z",
    "disabledReason": "NOT_TSA_APPLICABLE",
    "enabledForFlight": true,
    "hasChanges": true,
    "lastMessageType": "string",
    "note": "string",
    "tsaPendingResponse": true,
    "tsaSendDate": "2019-08-24T14:15:22Z"
  }
}

Flight Planning Notes

Operations related to planning notes for flights.

Operations

Flight Post Flight

Operations related to post-flight activities.

Operations

Flight Pre Flight

Operations related to pre-flight operations.

Operations

Flight Sanction List

Operations related to flight sanctions and approvals.

Operations

Flight Travel Authorization

These endpoints are designed to manage travel authorization details for passengers on flights.

Key Features

  • Travel Authorization Status: Check and update the travel authorization status for passengers.

Business Value

  • Compliance: Helps to meet regulatory requirements.
  • Operational Efficiency: Streamlines the process of managing travel authorizations, reducing the time and effort required.
  • Risk Management: Minimizes the risk of travel disruptions due to missing or invalid travel documents.

Use Cases

  • Flight Operations Management: Review and manage travel authorization details for passengers on specific flights.
  • Customer Service: Assist passengers in ensuring they have the necessary travel documents for their journey.
  • Regulatory Compliance: Maintain accurate records of travel authorizations to meet regulatory requirements.

Why Use These Endpoints

The Flight Travel Authorization endpoints are essential tools for maintaining compliance and operational efficiency within the aviation industry.

Operations

Flight Tickets

Operations related to flight tickets.

Operations

Quotes

Create, retrieve, update and delete quotes, list unbooked quotes and record owner approval.

Operations

Quote Pricing

Provisional quote lookup and quote prices, including booked snapshot prices.

Operations

Quote Booking

Book, confirm, update and cancel quotes, search bookings and update booking payment status. Book and confirm are also listed under Flights as New Flights.

Operations

Quote Versions

Operations related to versions of quotes.

Operations

Quote History

The change history of a quote and its booked snapshot.

Operations

Quote Attachments

Operations related to documents and files attached to flight quotes.

Operations

Quote Expenses

Expenses recorded against a quote. Also listed under Accounting.

Operations

Roster

Operations related to Rosters.

Operations

Users

Operations related to Users.

Operations