Operations related to accounts.
- Set Crew Flight Hours
Get Crew
Get a Crew Member
Get Crew Flight Hours
Search a crew member
Set Crew Flight Hours
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
Overview
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
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
Request
Returns the current flight time of a crew member per engine class. All values are in minutes, for example 90 means 1 hour 30 minutes.
Each engine class (multi engine and single engine) shows the starting value entered for the crew member in FL3XX plus the flights logged in FL3XX since the date of that starting value.
- An engine class without a starting value returns null for the class and for its PIC value.
totalismultiEngineplussingleEngine, andpicispicMultiEnginepluspicSingleEngine, counting only the classes that have a value. Both are null when neither class has a value.
A reference that does not resolve to a user of your operator returns 404.
Security
API_AUTHENTICATION
- Test Serverhttps://test.fl3xx.com/api/external/user/crew/{reference}/flighthours
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://test.fl3xx.com/api/external/user/crew/{reference}/flighthours' \
-H 'X-Auth-Token: YOUR_API_KEY_HERE'Success
Pilot in command flight time across both engine classes, in minutes: picMultiEngine plus picSingleEngine. Computed and read only, a PUT that sends it is rejected with 400.
Pilot in command flight time on multi engine aircraft, in minutes. Cannot be above multiEngine.
Pilot in command flight time on single engine aircraft, in minutes. Cannot be above singleEngine.
Response
application/json
{ "multiEngine": 252000, "picMultiEngine": 180000, "singleEngine": 51000, "picSingleEngine": 36000, "total": 303000, "pic": 216000 }
Request
Sets the current flight time of a crew member and returns the updated flight time, in the same shape as the GET. All values are in minutes, in the request and in the response, for example 90 means 1 hour 30 minutes.
Send at least one of multiEngine, singleEngine, picMultiEngine and picSingleEngine. A field that is left out or null keeps its current value.
How a value is stored: each engine class keeps its start date. FL3XX sets the starting value of the class so that the starting value plus the flights logged in FL3XX since that date equals the value you sent. An engine class without a starting value starts today, with the sent value as its starting value.
The request is rejected with 400 and nothing is changed when:
totalorpicis sent. Both are computed from the engine classes.- none of the four fields is sent.
- a value is negative or above 6000000 (100,000 hours).
- a PIC value is above the value of its engine class, also when one of the two is not sent and its current value is used.
- a value is below the minutes logged in FL3XX since the start date of its engine class.
- the non PIC part of an engine class (the class value minus its PIC value) is below the non PIC minutes logged in FL3XX since the start date of the class.
The error message names the field and, where it applies, the lowest or highest accepted value.
A reference that does not resolve to a user of your operator returns 404.
Security
API_AUTHENTICATION
Pilot in command flight time on multi engine aircraft, in minutes. Cannot be above multiEngine.
Pilot in command flight time on single engine aircraft, in minutes. Cannot be above singleEngine.
- Test Serverhttps://test.fl3xx.com/api/external/user/crew/{reference}/flighthours
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://test.fl3xx.com/api/external/user/crew/{reference}/flighthours' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: YOUR_API_KEY_HERE' \
-d '{
"multiEngine": 252000,
"picMultiEngine": 180000,
"singleEngine": 51000,
"picSingleEngine": 36000
}'Success, the updated flight time
Pilot in command flight time across both engine classes, in minutes: picMultiEngine plus picSingleEngine. Computed and read only, a PUT that sends it is rejected with 400.
Pilot in command flight time on multi engine aircraft, in minutes. Cannot be above multiEngine.
Pilot in command flight time on single engine aircraft, in minutes. Cannot be above singleEngine.
Response
application/json
{ "multiEngine": 252000, "picMultiEngine": 180000, "singleEngine": 51000, "picSingleEngine": 36000, "total": 303000, "pic": 216000 }
- Test Serverhttps://test.fl3xx.com/api/external/user/crew
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://test.fl3xx.com/api/external/user/crew?externalReference=string&pilotId=0' \
-H 'X-Auth-Token: YOUR_API_KEY_HERE'Response
application/json
{ "account": { "accountNumber": 1111, "accountid": 1111, "email": "email@fl3xx.com", "externalReference": "fl3xx_123456", "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": 6000000, "pic": 0, "picMultiEngine": 6000000, "picSingleEngine": 6000000, "singleEngine": 6000000, "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" }
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
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