DynoFlight Logo
DynoFlight
Powered by Jet.AI

API Documentation

Description

Retrieves the burn rate information for a specific aircraft model based on its ID.

GET

Parameters
  • id (query) - The unique identifier of the aircraft model.
Responses

200: Success - Returns the burn rate details of the specified aircraft model.

Example success response:

{"burnRate": "value"}

Example error response:

{"error": "Method Not Allowed"}

Description

Retrieves detailed information about the company.

GET

Response Attributes
  • id: Unique identifier of the company.
  • name: Name of the company.
  • description: Description of the company and its operations.
  • location: Physical address of the company.
  • country_code: Country code where the company is located.
  • margin: Operational margin percentage.
  • discount: Discount percentage offered by the company.
  • is_active: Indicates if the company is currently active.
  • is_deleted: Indicates if the company record has been deleted.
  • time_created: Timestamp of when the company record was created.
Example Response
{ "id": "uuid-123", "name": "Acme Corporation", "description": "A company that specializes in everything.", "location": "123 Acme Way, Anytown, AN", "country_code": "AN", "margin": 10.5, "discount": 2.5, "is_active": true, "is_deleted": false, "time_created": "2023-01-01T00:00:00Z" }

Description

Retrieves emissions data, utilizing caching for optimized response times.

GET

Response

Returns emissions data. If cached data is available, it returns the cached data to reduce database queries and improve response time.

Example success response (JSON structure depends on database schema):

{ "emissionsData": [ { "id": "uuid-456", "category": "Transport", "amount": 1500, "unit": "kgCO2e", "date": "2023-01-02" }, // More data... ] }

Description

Retrieves detailed information about a specific emission record by its unique ID.

GET

Path Parameters
  • emission_id: The unique identifier of the emission record.
Response

Returns detailed data for the specified emission, including company ID, aircraft ID, fuel type, flight duration, carbon emitted, and calculation status.

Example success response:

{ "id": "uuid-456", "companyId": "uuid-789", "aircraftId": "uuid-123", "fuelType": "Jet A", "flightDuration": 2.5, "carbonEmitted": 1500, "isCalculated": true, "timeEmitted": "2023-02-15T00:00:00Z", "timeCreated": "2023-02-16T00:00:00Z", "timeUpdated": "2023-02-17T00:00:00Z" }

Description

Retrieves information about all available aircraft models, with optional filtering by name, burn rate, and active status.

GET

Query Parameters
  • name (optional): Filter models by name.
  • isActive (optional): Filter models by their active status (true/false).
  • burnRate (optional): Filter models by burn rate.
Response

Returns a list of aircraft models matching the query parameters.

Example success response:

[{"id": "uuid-1", "name": "Boeing 747", "burnRate": 5, "isActive": true}, ...]

Description

Retrieves detailed information about an aircraft model by its unique ID.

GET

Path Parameters
  • model_id: The unique identifier of the aircraft model.
Response

Returns detailed information of the specified aircraft model including name, burn rate, and active status.

Example success response:

{ "id": "model-uuid", "name": "Boeing 787", "burnRate": 5.2, "isActive": true }

Description

Retrieves a list of provisions, optionally filtering by reconciliation status, company ID, or whether the provision is marked as deleted.

GET

Query Parameters
  • isReconciled (optional): Filter provisions by their reconciliation status (true/false).
  • companyId (optional): Filter provisions associated with a specific company ID.
  • isDeleted (optional): Filter provisions by whether they are marked as deleted (true/false).
Response

Returns a list of provisions matching the query parameters, each including detailed information such as description, carbon amount, price, and reconciliation status.

Example success response:

[ { "id": "uuid-1", "companyId": "uuid-123", "description": "Tree Planting Initiative", "carbonAmount": 100, "price": 2000, "isReconciled": false, "isDeleted": false, "timeCreated": "2023-01-01T00:00:00Z", "timeUpdated": "2023-01-02T00:00:00Z" }, ... More provisions ... ]

Description

Fetches detailed information for a specific provision by its unique ID. This endpoint can be used to retrieve, update, or delete an individual provision.

GET

Path Parameters
  • provision_id: The unique identifier of the provision.
Response

Returns details of the specified provision, including the company ID, description, carbon amount, and price.

Example success response:

{ "id": "provision-uuid", "companyId": "company-uuid", "description": "Renewable Energy Project", "carbonAmount": 1000, "price": 25000, "isReconciled": false }

Description

Retrieves detailed information about a specific source by its ID. Allows updates and deletions to source entries.

GET

Path Parameters
  • source_id: Unique identifier for the source to retrieve.
Response

Returns detailed data for the source, including name, description, price, and certification details.

Example success response:

{ "id": "source-uuid", "name": "Wind Farm Project", "description": "A project dedicated to generating renewable energy", "price": 50, "puroId": "PURO123", "country": "DE", "region": "Bavaria", "city": "Munich", "category": "Energy", "website": "https://windfarmporject.com", "logo": "https://windfarmporject.com/logo.png", "certification": "VCS", "certificationDate": "2021-06-01T00:00:00Z", "isActive": true }

Description

Fetches comprehensive details about a specific invoice, including associated provisions, total carbon offset, price details, and status.

GET

Path Parameters
  • invoice_id: Unique identifier of the invoice to retrieve.
Response

Returns detailed information about the specified invoice, such as company ID, carbon total, credit total, price total, and completion status.

Example success response:

{ "id": "uuid-234", "companyId": "uuid-123", "carbonTotal": 5000, "creditTotal": 200, "priceTotal": 15000, "stripeLink": "https://stripe.com/invoice/uuid-234", "isComplete": true, "isActive": true, "isDeleted": false, "timeCompleted": "2023-03-17T12:00:00Z", "timeCreated": "2023-01-01T00:00:00Z", "timeUpdated": "2023-03-01T00:00:00Z" }

Description

This API endpoint will allow for the generation and retrieval of various reports related to emissions, provisions, and other environmental metrics. Detailed documentation and examples will be provided upon completion of this feature.

Expected Methods

GET, POST (More details coming soon)

Expected Parameters

Details about required and optional parameters will be added in the future.

Example Usage

Examples of how to interact with this endpoint will be shared once it is fully implemented.

Expected Responses

Information on successful and error responses will be provided upon the endpoint's completion.

Description

FL3XX Sync API provides seamless integration between FL3XX and third-party systems, allowing you to synchronize data effortlessly. Stay tuned for updates!

Parameters

  • from: Start date parameter in YYYY-MM-DD format
  • to: End date parameter in YYYY-MM-DD format
  • include: (Optional) Additional data to include
  • timeZone: (Optional) Time zone for date parameters

Response

The response is a JSON array containing Flight objects with the following properties:

{
    "accountId": number,
    "accountName": string,
    "accountReference": string,
    "accountTrigram": string,
    "aircraftAOC": {
        "id": number,
        "name": string
    },
    "aircraftCategory": string,
    "airportFrom": string,
    "airportTo": string,
    "blockOffEstLocal": string, // Date in ISO 8601 format
    "blockOffEstUTC": string, // Date in ISO 8601 format
    "blockOnEstLocal": string, // Date in ISO 8601 format
    "blockOnEstUTC": string, // Date in ISO 8601 format
    "bookingIdentifier": string,
    "bookingReference": string,
    "customerFirstname": string,
    "customerId": string,
    "customerLastname": string,
    "customerTrigram": string,
    "dateFrom": string, // Date in ISO 8601 format
    "dateTo": string, // Date in ISO 8601 format
    "eta": string, // Date in ISO 8601 format
    "etd": string, // Date in ISO 8601 format
    "flightId": number,
    "flightNumber": string,
    "flightNumberCompany": string,
    "flightStatus": string,
    "flightType": string,
    "fuelArrival": number,
    "fuelMassUnit": string,
    "fuelOffBlock": number,
    "fuelRemainigActual": number,
    "operator": {
        "id": number,
        "name": string
    },
    "paxNumber": number,
    "paxReferences": [
        {
            "comment": string,
            "documentExternalReference": string,
            "externalReference": string,
            "internalId": number,
            "isMain": boolean,
            "links": {
                "empty": boolean
            },
            "paxExternalReference": string,
            "paxType": string
        }
    ],
    "postFlightClosed": boolean,
    "realAirportFrom": string,
    "realAirportTo": string,
    "realDateIN": string, // Date in ISO 8601 format
    "realDateOFF": string, // Date in ISO 8601 format
    "realDateON": string, // Date in ISO 8601 format
    "realDateOUT": string, // Date in ISO 8601 format
    "registrationNumber": string,
    "requestedAircraftType": string,
    "rescheduledDateFrom": string, // Date in ISO 8601 format
    "rescheduledDateTo": string, // Date in ISO 8601 format
    "status": string,
    "tripNumber": number,
    "upliftMass": number,
    "userReference": string,
    "workflow": string,
    "workflowCustomName": string
}

© 2024 Jet.AI - Docs Generated using AI