SKskyvexsoftware
Flights

Position and phase update

Changed on

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 reference phpVMS module reads phase case-insensitively and maps it to a PIREP status:

Stratos phasephpVMS status
BOARDINGBOARDING
PUSH_BACKPUSHBACK_TOW
TAXI / REJECTED_TAKE_OFF / TAXI_TO_GATETAXI
TAKE_OFFTAKEOFF
CLIMB / CRUISEENROUTE
DESCENT / GO_AROUNDAPPROACH
APPROACHAPPROACH_ICAO
FINALLANDING
LANDEDLANDED
DEBOARDINGON_BLOCK
PAUSEDPAUSED
UNKNOWN, or any other valueENROUTE

It also accepts lower-case values and the older names taxi_in, arrived, on_block, climb_out and diverted. The first update that reaches TAKEOFF, INIT_CLIM or ENROUTE sets block_off_time. The first update that reaches ON_BLOCK or 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

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_TO_GATE' | 'DEBOARDING' | 'PAUSED' | 'UNKNOWN' required

Current flight phase as Stratos sends it, in capitals. TAXI_IN and ARRIVED are both sent as TAXI_TO_GATE, PAUSED is sent while the simulator is paused, and UNKNOWN before a phase is detected. The reference implementation reads the value case-insensitively and treats anything it doesn't know as CRUISE (PirepStatus::ENROUTE).

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

Changes

  • 51e47958ed25Revision changes
    • breaking

      removed the enum value approach of the request property

    • breaking

      removed the enum value arrived of the request property

    • breaking

      removed the enum value boarding of the request property

    • breaking

      removed the enum value climb of the request property

    • breaking

      removed the enum value cruise of the request property

    • breaking

      removed the enum value deboarding of the request property

    • breaking

      removed the enum value descent of the request property

    • breaking

      removed the enum value final of the request property

    • breaking

      removed the enum value go_around of the request property

    • breaking

      removed the enum value landed of the request property

    • breaking

      removed the enum value push_back of the request property

    • breaking

      removed the enum value rejected_take_off of the request property

    • breaking

      removed the enum value take_off of the request property

    • breaking

      removed the enum value taxi of the request property

    • breaking

      removed the enum value taxi_in of the request property

    • info

      added the new APPROACH enum value to the request property

    • info

      added the new BOARDING enum value to the request property

    • info

      added the new CLIMB enum value to the request property

    • info

      added the new CRUISE enum value to the request property

    • info

      added the new DEBOARDING enum value to the request property

    • info

      added the new DESCENT enum value to the request property

    • info

      added the new FINAL enum value to the request property

    • info

      added the new GO_AROUND enum value to the request property

    • info

      added the new LANDED enum value to the request property

    • info

      added the new PAUSED enum value to the request property

    • info

      added the new PUSH_BACK enum value to the request property

    • info

      added the new REJECTED_TAKE_OFF enum value to the request property

    • info

      added the new TAKE_OFF enum value to the request property

    • info

      added the new TAXI enum value to the request property

    • info

      added the new TAXI_TO_GATE enum value to the request property

    • info

      added the new UNKNOWN enum value to the request property