Updates
Open FL3XX APP - Sandbox
Back to All
added

New Endpoints: Read/Write Dispatch Migration Details

10 months ago

Dear Developers,

We are pleased to introduce a development aimed at expanding the capabilities of the FL3XX API. The Migration section of the Dispatch module, specifically Emigration and Immigration, is now accessible through the API.

Endpoints Added

  • GET /api/external/flight/{flightId}/migration
  • PUT /api/external/flight/{flightId}/migration

Usage Guidelines

  1. Determine the relevant flightId (e.g. via GET /api/external/flight/flights).
  2. GET the migrations information for the given flightId.
  3. Use the received ExternalMigrationsDto as the basis for your PUT payload (ExternalMigrationsDto_1).
  4. Modify the payload as needed to incorporate your updated information.
  5. PUT the payload back at the same flightId to effect updates.

The ExternalMigrationDto_1 Model

Within the PUT payload, the model ExternalMigrationDto_1 describes the values for departureMigration (Emigration) and arrivalMigration (Immigration). The following list provides some additional detail regarding the constituent parts of an ExternalMigrationDto_1 object.

  1. status The migration status (OK, REQ, DO, etc.)
    1. Note: Setting a *_REVISED status (e.g. "OK_REVISED") sets visual flags in the UI to indicate to a user that some aspect of the associated migration details for this flight has changed and requires their attention before proceeding with regular dispatch operations for the flight.
  2. by The entity assigned to handle this aspect of the flight.
  3. notes The text to store in the migration's Notes field.
  4. documents An array of objects representing documents that have been attached to this migration.
  5. id The internal identifier for this set of migration details.
  6. permitProviderId The internal ID of a user-assigned Trip Support entity.
    1. If a user has assigned the migration to one of the Trip Support entities configured in their instance, by will be set to PERMIT_PROVIDER, and permitProviderId will hold the internal ID of that Trip Support entity.
    2. These providers are operator-defined, and are not currently indexable via the FL3XX API.

Specification

The full definitions for these endpoints, the models used, and example values for payloads can be found within the group /api/external/flights on the OpenAPI Specification page (SWAGGER UI). If you encounter any challenges or have questions, contact us at [email protected].

Best regards,
FL3XX API Team