Skip to content
/
Get qualification type by...

FL3XX API (2.0.0)

FL3XX API v2.0 - Beta Release

Currently in active development with our trusted beta partners. Experience the next generation of aviation API technology.

BETA
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/

Airports

Access comprehensive airport information.

Business Value

  • Filter airports by various criteria including ICAO, IATA, FAA codes and local identifiers
  • Support high-performance applications with optimized data retrieval

Use Cases

  • Filter airports by specific codes for targeted data retrieval
  • Integrate airport data into flight planning and scheduling systems
  • Build airport selection interfaces with efficient pagination

Operations

Airport Fuel Prices

Manage and optimize airport fuel pricing data for your organization. These endpoints enable operators to efficiently update, remove, and bulk-manage fuel prices, supporting streamlined fuel order workflows and provider management.

Business Value

  • Ensure accurate and up-to-date fuel pricing for all airport operations.
  • Reduce manual effort and errors by enabling bulk updates and deletions.
  • Support cost control and negotiation with providers through transparent pricing data.
  • Enhance operational planning and financial forecasting with reliable fuel cost data.

Use Cases

  • Update fuel prices for a specific airport to reflect new agreements or market changes.

  • Remove outdated or incorrect fuel prices for compliance and data integrity.

  • Perform bulk deletions to quickly adapt to network-wide pricing changes.

  • Integrate with internal systems to automate fuel price management and reporting.


Note:

The data managed by the Airport Fuel Prices endpoints is strictly bound to the context of the operator associated with the calling authentication token. All operations—creating, updating, or deleting airport fuel prices—apply only to the operator for which the provided token is valid.

Operations

Webhooks

Manage webhook subscriptions for near real-time event notifications. These endpoints enable partners to create, manage, and monitor webhook subscriptions for receiving flight-related events and updates.

Business Value

  • Receive near real-time notifications for flight events and updates.
  • Automate integration workflows with external systems.
  • Monitor flight operations and passenger changes in near real-time.
  • Reduce polling overhead by using event-driven architecture.

Use Cases

  • Subscribe to flight updates to sync data with external booking systems.
  • Monitor passenger count changes for catering and ground service coordination.
  • Track aircraft changes for maintenance and operational planning.
  • Receive notifications for flight cancellations and time updates.

Available Event Types:

  • FLIGHT_CREATE: New flight creation
  • FLIGHT_CANCEL: Flight cancellation
  • FLIGHT_TIME_UPDATE: Flight time changes
  • FLIGHT_AIRCRAFT_UPDATE: Aircraft assignment changes
  • FLIGHT_AIRPORT_UPDATE: Airport(s) changes
  • FLIGHT_POST_FLIGHT_STATUS: Post-flight status updates
  • FLIGHT_MOVEMENT_UPDATE: Flight movement updates
  • FLIGHT_PAX_COUNT_UPDATE: Passenger count changes
  • FLIGHT_PAX_LIST_UPDATE: Passenger list changes (e.g. new passengers, updated list, passenger document changes, etc.)
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.

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

Get qualification types

Request

Retrieve available qualification types and their details for use in crew qualification assignments.

Features:

  • Returns paginated list of available qualifications
  • Includes qualification metadata and configuration

Example Use Case: An operations manager needs to see all available qualification types in the system to properly assign qualifications to crew members.

Security
X-Api-Client-Id and X-Auth-Token
Query
limitinteger[ 10 .. 50 ]

Maximum number of records to return.

Default 10
Example: limit=20
offsetinteger>= 0

Number of records to skip before starting to return results.

Default 0
curl -i -X GET \
  'https://test.fl3xx.com/api/v2/external/qualification-types?limit=20&offset=0' \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully retrieved qualifications

Bodyapplication/json
dataArray of objects(QualificationDto)

The list of qualifications for the current page.

paginationobject(Pagination)

Pagination details

Response
application/json
{
  "data": [
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "totalItems": 150,
    "sortItems": [ … ],
    "filters": [ … ]
  }
}

Get qualification type by ID

Request

Retrieve detailed information about a specific qualification type.

Features:

  • Returns complete qualification configuration and metadata
  • Includes validity periods, grace periods, and relation information

Example Use Case: An operations manager needs to understand the specific requirements and configuration of a qualification type before assigning it to a crew member.

Security
X-Api-Client-Id and X-Auth-Token
Path
idstringrequired

The unique identifier of the qualification to retrieve

Example: qual-type-12345
curl -i -X GET \
  https://test.fl3xx.com/api/v2/external/qualification-types/qual-type-12345 \
  -H 'X-Api-Client-Id: YOUR_API_KEY_HERE' \
  -H 'X-Auth-Token: YOUR_API_KEY_HERE'

Responses

Successfully retrieved qualification

Bodyapplication/json
idstring

Unique identifier for the qualification type

Example: "qual-type-12345"
namestring

Name of the qualification type

Example: "Airline Transport Pilot License"
abbreviationstring

Abbreviated name of the qualification

Example: "ATPL"
warningstring

Warning message associated with the qualification

Example: "Requires medical certificate"
notesstring

Additional notes about the qualification

Example: "Valid for commercial operations"
parentIdstring

Identifier of the parent qualification (if applicable)

Example: "parent-qual-123"
appliesTostring

Specifies which crew positions this qualification applies to

Enum"FLIGHT_DECK""PIC""SIC""CREW_CABIN""CREW_POSITIONS_AND_ROLES"
Example: "FLIGHT_DECK"
typestring

Type of qualification

Enum"LICENSE""CERTIFICATE""RATING""ENDORSEMENT""TRAINING""MEDICAL""OTHER"
Example: "LICENSE"
trainingTypestring

Type of training required for this qualification

Enum"INITIAL""RECURRENT""REFRESHER""CONVERSION""OTHER"
Example: "INITIAL"
isActiveboolean

Whether this qualification type is currently active

Example: true
validityobject(ValidityDto)
gracePeriodobject(GracePeriodDto)
relationsArray of objects(QualificationRelationDto)

Relations to other entities (aircraft, airports, etc.)

alternativeQualificationIdsArray of strings

List of alternative qualification IDs

Example: ["alt-qual-1","alt-qual-2"]
createdAtDateTimestring(date-time)

Date and time when the qualification type was created

Example: "2024-01-15T10:30:00.000Z"
updatedAtDateTimestring(date-time)

Date and time when the qualification type was last updated

Example: "2024-01-15T10:30:00.000Z"
Response
application/json
{
  "id": "qual-type-12345",
  "name": "Airline Transport Pilot License",
  "abbreviation": "ATPL",
  "warning": "Requires medical certificate",
  "notes": "Valid for commercial operations",
  "parentId": "parent-qual-123",
  "appliesTo": "FLIGHT_DECK",
  "type": "LICENSE",
  "trainingType": "INITIAL",
  "isActive": true,
  "validity": {
    "unit": "MONTHS",
    "value": 24
  },
  "gracePeriod": {
    "start": { … },
    "end": { … }
  },
  "relations": [
    { … }
  ],
  "alternativeQualificationIds": [
    "alt-qual-1",
    "alt-qual-2"
  ],
  "createdAtDateTime": "2024-01-15T10:30:00.000Z",
  "updatedAtDateTime": "2024-01-15T10:30:00.000Z"
}