Sign in

v1

latestOpenAPI 3.1.02026-07-22162733.8 KB
Flights

Position and phase update

Sent by the desktop client at the pilot's chosen position-update interval (currently 15, 30, or 60 seconds) while a flight is active. Each call appends a FLIGHT_PATH point to the PIREP and updates the PIREP's status based on the reported phase.

The server maps Stratos flight phases to phpVMS PIREP statuses:

Stratos phasephpVMS status
boardingBOARDING
push_backPUSHBACK_TOW
taxiTAXI
take_offTAKEOFF
rejected_take_offTAXI
climb / cruiseENROUTE
descentAPPROACH
approachAPPROACH_ICAO
finalLANDING
landed / taxi_inLANDED
go_aroundAPPROACH
arrived / deboardingARRIVED

The first update that transitions into a takeoff/climb/cruise status sets block_off_time. The first update transitioning into LANDED/ARRIVED sets block_on_time. The server's running flight time is recomputed from the first ACARS row's created_at each update.

Either uuid or tracking_id may carry the PIREP ID (the client uses them interchangeably).

post/flights/update

Request body

uuidstring uuid

PIREP ID returned by /flights/start. Use either this or tracking_id.

tracking_idstring uuid

Synonym for uuid — supplied for backwards compatibility.

phase'boarding' | 'push_back' | 'taxi' | 'take_off' | 'rejected_take_off' | 'climb' | 'cruise' | 'descent' | 'approach' | 'final' | 'landed' | 'go_around' | 'taxi_in' | 'arrived' | 'deboarding' required

Current flight phase. Unknown values are treated as cruise (PirepStatus::ENROUTE) by the reference implementation.

latitudenumber double required
longitudenumber double required
altitudenumber required

Indicated altitude in feet.

headingnumber float required

True heading in degrees.

ground_speednumber float

Ground speed in knots. Defaults to 0 if omitted.

distance_remainingnumber float

Nautical miles remaining to destination. Used to compute the cumulative distance written to the FLIGHT_PATH row.

Response

Update accepted. The reference implementation returns an empty body.

object nullable required