v1

latestOpenAPI 3.1.02026-07-22162733.8 KB

Flights

Change a bid's aircraft

Assigns a different aircraft to a bid before the flight is started. Persists the bid's aircraft so /flights/start uses it. The chosen aircraft must be one returned by GET /flights/bookings/{bid}/aircraft. Rejected when the authenticated pilot has their own SimBrief OFP for the flight, once a PIREP is in progress, and for aircraft outside the flight's eligible set.

post/flights/change-aircraft

Request body

bid_idinteger required

aircraft_idinteger required

Must be one of the IDs from GET /flights/bookings/{bid}/aircraft.

Response

Updated booking.

bid_idinteger required

Unique bid ID. Used by /flights/start and /flights/unbook.

numberstring required

Flight number (no airline code).

codestring required

Operating airline code.

departure_airportstring required

Departure airport ID (ICAO).

arrival_airportstring required

routestring[] required

Route waypoints split on whitespace. Empty array if no route is filed.

flight_levelstring required

Cruise altitude as filed (free-form string, e.g. 360 or FL360).

distancenumber float required

Great-circle distance in the VA's configured local unit (typically nautical miles).

departure_timestring required

Scheduled departure, free-form per VA setting.

arrival_timestring required

flight_timenumber float required

Scheduled flight time in decimal hours.

days_of_weekinteger[] required

Days the flight operates (0 = Sunday). Empty if not configured.

type'P' | 'C' required

Coarse flight category derived from phpVMS's flight_type. P = passenger (scheduled/charter/extra/govt/other), C = cargo (ambulance/cargo/training/mail/military/positioning/special/general aviation/technical).

aircraftinteger nullable required

Aircraft ID assigned to the bid: the SimBrief airframe if set, otherwise the bid's aircraft. Null when no aircraft is assigned — the pilot must pick one (e.g. via /flights/change-aircraft) before starting.

aircraft_changeableboolean

Whether the pilot may switch the aircraft for this bid before starting. False when the authenticated pilot has their own SimBrief OFP for this flight — per-pilot, so another pilot's OFP does not lock it. Drives the client's dropdown-vs-text rendering.

notesstring required

Example response

{
  "departure_airport": "YSSY",
  "arrival_airport": "YMML",
  "route": [
    "YSSY",
    "DCT",
    "RIC",
    "YMML"
  ],
  "departure_time": "0930",
  "arrival_time": "1145",
  "flight_time": 1.42
}