FSS API Documentation

Table of Contents

aircraft/aircraftType.proto

Top

AircraftType

FieldTypeLabelDescription
id string

type string

flight/aircraft.proto

Top

Aircraft

FieldTypeLabelDescription
registration string

aircraft_performance_uuid string

climb_speed_schedule SpeedSchedule

cruise_speed_schedule SpeedSchedule

descent_speed_schedule SpeedSchedule

maximum_altitude com.fss.grpc.globals.nav.Altitude

weights Aircraft.Weights

fuel Aircraft.Fuel

Aircraft.Fuel

FieldTypeLabelDescription
apu_fuel_flow_per_hour Weight

Additional fuel flow for auxiliary power unit

taxi_fuel_per_minute Weight

anti_ice_fuel_bias float

air_conditioning_fuel_bias float

mel_cdl_fuel_bias float

Fuel bias adjustment by MEL/CDL items

other_fuel_bias float

Fuel bias adjustment by other equipment like cooling

hold_fuel_bias float

Given as factor eg. 1.02

climb_fuel_bias float

Given as factor eg. 1.02

cruise_fuel_bias float

Given as factor eg. 1.02

descent_fuel_bias float

Given as factor eg. 1.02

Aircraft.Weights

FieldTypeLabelDescription
dry_operating_weight Weight

maximum_zero_fuel_weight Weight

maximum_take_off_weight Weight

maximum_ramp_weight Weight

maximum_landing_weight Weight

flight/flightInfo.proto

Top

FlightInfo

FieldTypeLabelDescription
operator string

flight_number string

commercial_flight_number string

operational_suffix string

departure_airport com.fss.grpc.globals.nav.Airport

departure_runway string

arrival_airport com.fss.grpc.globals.nav.Airport

arrival_runway string

nav_data_uuid string

air_data_uuid string

from_waypoint FlightInfo.WaypointData

to_waypoint FlightInfo.WaypointData

times FlightInfo.Times

aircraft Aircraft

payload FlightInfo.Payload

optimization FlightInfo.Optimization

options FlightInfo.Options

weight_units Weight.Units

FlightInfo.Options

FieldTypeLabelDescription
ignore_route_restrictions bool

ignore_maximum_altitude_restrictions bool

ignore_minimum_altitude_restrictions bool

ignore_aircraft_equipment_restrictions bool

ignore_standard_instrument_departure_route_altitude_restrictions bool

ignore_standard_instrument_arrival_route_altitude_restrictions bool

ignore_airway_directions bool

ignore_route_charges bool

ignore_restricted_areas bool

FlightInfo.Payload

FieldTypeLabelDescription
payload Weight

baggage Weight

cargo Weight

adults int32

males int32

females int32

children int32

infants int32

FlightInfo.Times

FieldTypeLabelDescription
scheduled_block_off_time string

scheduled_block_on_time string

estimated_block_off_time string

estimated_block_on_time string

taxi_out_time string

taxi_in_time string

FlightInfo.WaypointData

FieldTypeLabelDescription
waypoint com.fss.grpc.globals.nav.Waypoint

altitude com.fss.grpc.globals.nav.Altitude

iso_8601_time_at string

grossWeight Weight

FlightInfo.Optimization

NameNumberDescription
COST 0

FUEL 1

TIME 2

DISTANCE 3

flight/speed.proto

Top

Speed

FieldTypeLabelDescription
unit Speed.Units

value float

Speed.Units

NameNumberDescription
KNOTS 0

KILOMETERS_PER_HOUR 1

METERS_PER_SECOND 2

MACH 3

flight/speedSchedule.proto

Top

SpeedSchedule

FieldTypeLabelDescription
type SpeedSchedule.Type

value string

nr_of_engines_inoperative int32

inflight_only bool

min_altitude com.fss.grpc.globals.nav.Altitude

speed_schedule_below_min_altitude SpeedSchedule

SpeedSchedule.Type

NameNumberDescription
COST_INDEX_KG 0

COST_INDEX_LB 1

MACH 2

CUSTOM 3

flight/volume.proto

Top

Volume

FieldTypeLabelDescription
unit Volume.Units

value float

Volume.Units

NameNumberDescription
LITER 0

US_GALLONS 1

IMPERIAL_GALLONS 2

flight/weight.proto

Top

Weight

FieldTypeLabelDescription
unit Weight.Units

value float

type Weight.Type

Weight.Type

NameNumberDescription
VALUE 0

MINIMUM 1

MAXIMUM 2

Weight.Units

NameNumberDescription
KILOGRAM 0

POUNDS 1

met/airdata.proto

Top

AirData

FieldTypeLabelDescription
wind Wind

temperature Temperature

isa_deviation Temperature

icing float

shear float

tropopause com.fss.grpc.globals.nav.Altitude

met/airdatafileset.proto

Top

AirDataFileSet

FieldTypeLabelDescription
id string

expiry_date string

type_id string

type string

source_id string

source string

name string

uploadedAt string

md5 string

met/temperature.proto

Top

Temperature

FieldTypeLabelDescription
units Temperature.Units

value float

Temperature.Units

NameNumberDescription
CELSIUS 0

FAHRENHEIT 1

KELVIN 2

met/wind.proto

Top

Wind

FieldTypeLabelDescription
direction com.fss.grpc.globals.nav.Track

speed com.fss.grpc.globals.flight.Speed

misc/config.proto

Top

Config

FieldTypeLabelDescription
key string

value string

JSON String - use JSON.stringify / JSON.parse

type string

meta_info ConfigMetaInfo

ConfigMetaInfo

FieldTypeLabelDescription
description string

category string

permissionGroup string

min_value string

max_value string

allowed_values string

JSON String

default_value string

misc/configCategory.proto

Top

ConfigCategory

FieldTypeLabelDescription
uuid string

name string

misc/configPermissionGroup.proto

Top

ConfigPermissionGroup

FieldTypeLabelDescription
uuid string

permission_group ConfigPermissionGroup.PermissionGroup

ConfigPermissionGroup.PermissionGroup

NameNumberDescription
Admin 0

SuperAdmin 1

misc/requestStatus.proto

Top

RequestStatus

FieldTypeLabelDescription
status RequestStatus.Status repeated

RequestStatus.Status

FieldTypeLabelDescription
code RequestStatus.Status.Code

message string

origin string

RequestStatus.Status.Code

NameNumberDescription
INFO 0

CAUTION 1

WARNING 2

ERROR 3

Top

Airport

FieldTypeLabelDescription
icao_code string

iata_code string

name string

country_code string

area_code string

fir string

uir string

point Point

elevation Altitude

longest_runway Runway

magnetic_variation Angle

type Airport.Type

ifr_capability bool

runways Runway repeated

Airport.Type

NameNumberDescription
CIVIL 0

MILITARY 1

PRIVATE 2

JOINT_CIVIL_AND_MILITARY 3

Top

Airspace

FieldTypeLabelDescription
ident string

name string

country_code string

area_code string

type Airspace.Type

level Airspace.Level

lower_limit Altitude

upper_limit Altitude

segments Airspace.Segment repeated

center Point

For internal use only

maxDistFromCenter Distance

private Distance minDistFromCenter; TODO: evaluate minDist -> calculate XTrack Error

Airspace.Segment

FieldTypeLabelDescription
point Point

type Airspace.Segment.Type

arc_radius Distance

arc_bearing Track

arc_center Point

Airspace.Level

NameNumberDescription
BOTH 0

HIGH 1

LOW 2

Airspace.Segment.Type

NameNumberDescription
CIRCLE 0

GREAT_CIRCLE_LINE 1

RHUMB_LINE 2

CLOCKWISE_ARC 3

COUNTER_CLOCKWISE_ARC 4

Airspace.Type

NameNumberDescription
FLIGHT_INFORMATION_REGION 0

UPPER_INFORMATION_REGION 1

COMBINED_FIR_UIR 2

ATC_SECTOR 3

RESTRICTIVE_AIRSPACE 4

AIRMET 5

SIGMET 6

NOTAM 7

USER_DEFINED_AREA 8

Top

Airway

FieldTypeLabelDescription
identifier string

point_from Waypoint

point_to Waypoint

mid_point Point

altitude_window Altitude.Window

minimum_safe_altitude Altitude

rvsm_minimum_level Altitude

cruising_table CruisingTable

required_navigation_performance float

forward_course Track

back_course Track

country_code string

area_code string

direction Airway.Direction

routeType Airway.RouteType

level Airway.Level

Airway.Direction

NameNumberDescription
FORWARD 0

BACK 1

TWO_WAY 2

Airway.Level

NameNumberDescription
HIGH 0

LOW 1

BOTH 2

Airway.RouteType

NameNumberDescription
AIRWAY 0

RNAV_AIRWAY 1

TACAN_AIRWAY 2

CUSTOM_AIRWAY 3

CONTROL 4

DIRECT_ROUTE 5

UNDESIGNATED_ATS_ROUTE 6

Top

Altitude

FieldTypeLabelDescription
units Altitude.Units

value float

Altitude.Window

FieldTypeLabelDescription
minimum_altitude Altitude

maximum_altitude Altitude

Altitude.Units

NameNumberDescription
FEET 0

FEET_100 1

METER 2

METER_10 3

Top

Angle

FieldTypeLabelDescription
units Track.Units

value float

Top

ApproachType

NameNumberDescription
NOT_SET 0

LOCBCS_APP 1

B

VORDME_APP 2

D

FMS_APP 3

F

IGS 4

G

RNP_APP 5

H

ILS_APP 6

I

GLS_APP 7

J

LOC_APP 8

L

MLS_APP 9

M

NDB_APP 10

N

GPS_APP 11

P

NDBDME_APP 12

Q

RNAV_APP 13

R

VORTAC_APP 14

S

TACAN_APP 15

T

SDF_APP 16

U

VOR_APP 17

V

LDA_APP 18

X

Top

CalculatedRoute

FieldTypeLabelDescription
waypoints CalculatedRoute.Waypoint repeated

CalculatedRoute.Waypoint

FieldTypeLabelDescription
waypoint Waypoint

weight com.fss.grpc.globals.flight.Weight

fuelRemaining com.fss.grpc.globals.flight.Weight

fuel_used CalculatedRoute.Waypoint.FuelUsed

altitude Altitude

true_airspeed com.fss.grpc.globals.flight.Speed

speedSchedule com.fss.grpc.globals.flight.SpeedSchedule

air_data com.fss.grpc.globals.met.AirData

vertical_mode CalculatedRoute.Waypoint.VerticalMode

iso8601_timeElapsed string

iso8601_timeOver string

track Track

distanceGone Distance

CalculatedRoute.Waypoint.FuelUsed

FieldTypeLabelDescription
total com.fss.grpc.globals.flight.Weight

bias_fuel com.fss.grpc.globals.flight.Weight

anti_ice_fuel com.fss.grpc.globals.flight.Weight

apu_fuel com.fss.grpc.globals.flight.Weight

air_conditioning_fuel com.fss.grpc.globals.flight.Weight

mel_cdl_fuel com.fss.grpc.globals.flight.Weight

other_fuel com.fss.grpc.globals.flight.Weight

CalculatedRoute.Waypoint.VerticalMode

NameNumberDescription
CLIMB 0

CRUISE 1

DESCENT 2

Top

CruisingTable

FieldTypeLabelDescription
identifier string

elements CruisingTable.Element repeated

CruisingTable.Element

FieldTypeLabelDescription
course_from Track

course_To Track

track_is_magnetic bool

levels CruisingTable.Element.LevelElement repeated

CruisingTable.Element.LevelElement

FieldTypeLabelDescription
level_from Altitude

spacing Altitude

level_to Altitude

Top

Distance

FieldTypeLabelDescription
distanceUnit Distance.DistanceUnit

value float

Distance.DistanceUnit

NameNumberDescription
NAUTICAL_MILES 0

FEET 1

METER 2

KILOMETER 3

STATUTE_MILES 4

Top

FlightInformationRegion

FieldTypeLabelDescription
default_speed_units com.fss.grpc.globals.flight.Speed.Units

default_altitude_units Altitude.Units

default_cruising_table CruisingTable

fir_upper_limit Altitude

airspace Airspace

Top

AirportSet

FieldTypeLabelDescription
name string

airports Airport repeated

ConditionCombination

FieldTypeLabelDescription
time_sheets TimeSheet repeated

logical_operator string

condition_elements ConditionElement repeated

ConditionElement

FieldTypeLabelDescription
index float

designated_point Waypoint

navaid_point Waypoint

airspace Airspace

entered_airspace Airspace

exited_airspace Airspace

airport_set AirportSet

airport Airport

airway Airway

airway_segment Airway

direct_flight DirectFlight

upper_limit Altitude

lower_limit Altitude

condition_combination ConditionCombination

aircraft com.fss.grpc.globals.flight.Aircraft

equipment string

weather string

reference_with_location string

DirectFlight

FieldTypeLabelDescription
start_point Waypoint

end_point Waypoint

exceed_length Distance

start_airport Airport

end_airport Airport

FlightRestriction

FieldTypeLabelDescription
id string

designator string

instruction_text string

restriction_type string

regulated_routes RegulatedRoute repeated

condition_combination ConditionCombination

RegulatedRoute

FieldTypeLabelDescription
route_elements RouteElement repeated

RouteElement

FieldTypeLabelDescription
index float

designated_point Waypoint

navaid_point Waypoint

airspace Airspace

airport Airport

airway Airway

airway_segment Airway

direct_flight DirectFlight

upper_limit Altitude

lower_limit Altitude

speed com.fss.grpc.globals.flight.Speed

TimeSheet

FieldTypeLabelDescription
day string

iso8601_timestamp_start_time string

iso8601_timestamp_end_time string

iso8601_timestamp_reference_time string

Top

NavDataSet

FieldTypeLabelDescription
id string

original_file_name string

md5 string

uploaded_at string

valid_from string

valid_until string

nav_dataset_provider NavDataSetProvider

cycle_name string

Top

NavDataSetProvider

FieldTypeLabelDescription
id string

name string

Top

Point

FieldTypeLabelDescription
latitude float

longitude float

Top

Route

FieldTypeLabelDescription
circuitOutDistance Distance

circuitInDistance Distance

routeSegments Route.EnrouteSegment repeated

name string

originAirport Airport

departureProcedure TerminalProcedure

destinationAirport Airport

arrivalProcedure TerminalProcedure

Route.EnrouteSegment

FieldTypeLabelDescription
waypoint Waypoint

altitude_window Altitude.Window

inboundAirway Airway

Top

RouteFinderAirway

FieldTypeLabelDescription
from_point Point

from_key string

from_ident string

to_point Point

to_key string

to_ident string

identifier string

mid_point Point

minimum_enroute_altitude Altitude

maximum_authorized_altitude Altitude

cruising_table CruisingTable

forward_course Track

back_course Track

direction RouteFinderAirway.Direction

RouteFinderAirway.Direction

NameNumberDescription
FORWARD 0

BACK 1

BOTH 2

Top

Runway

FieldTypeLabelDescription
airportIcao string

ident string

length Distance

width Distance

stopway Distance

displaced_threshold Distance

surface Runway.Surface

surface_code Runway.SurfaceCode

true_bearing Track

landing_threshold_location Point

landing_threshold_elevation Altitude

Runway.Surface

NameNumberDescription
ASPHALT 0

GRAVEL 1

GRASS 2

UNKNOWN 3

Runway.SurfaceCode

NameNumberDescription
HARD 0

SOFT 1

WATER 2

UNDEFINED 3

Top

TerminalProcedure

FieldTypeLabelDescription
airport string

runway string

fmcProcedure string

fmcTransition string

atcProcedure string

atcTransition string

type TerminalProcedure.Type

approach TerminalProcedure.Approach

terminal_procedure_segments TerminalProcedure.Segment repeated

TerminalProcedure.Approach

FieldTypeLabelDescription
via string

type ApproachType

designator string

TerminalProcedure.Segment

FieldTypeLabelDescription
waypoint Waypoint

altitude_window Altitude.Window

TerminalProcedure.Type

NameNumberDescription
NOT_SET 0

SID 1

SID_TRANS 2

STAR 3

STAR_TRANS 4

APPROACH_TRANS 5

A

APPROACH 6

Top

Track

FieldTypeLabelDescription
trackUnit Track.Units

reference Track.Reference

value float

Track.Reference

NameNumberDescription
TRUE 0

MAGNETIC 1

Track.Units

NameNumberDescription
DEGREES 0

RAD 1

Top

Waypoint

FieldTypeLabelDescription
point Point

elevation Altitude

type Waypoint.Type

fmcIdent string

atcIdent string

name string

frequency string

country_code string

area_code string

is_terminal_waypoint bool

is_latitude_longitude_waypoint bool

is_rnav_waypoint bool

fir string

uir string

magentic_variation Angle

Waypoint.Type

NameNumberDescription
NOT_SET 0

VOR 1

VOR_DME 2

DME 3

VOR_TAC 4

NDB 5

LOCATOR 6

WAYPOINT 7

FIX 8

DEPARTURE_AIRPORT 9

ARRIVAL_AIRPORT 10

EDTO_ENTRY_POINT 11

EDTO_EXIT_POINT 12

EDTO_CRITICAL_FUEL_POINT 13

EDTO_EQUAL_TIME_POINT 14

EQUAL_TIME_POINT 15

BEGIN_OF_CLIMB 16

TOP_OF_CLIMB 17

TOP_OF_DESCENT 18

END_OF_DESCENT 19

VIRTUAL_FIX 20

airDataProvider/airDataProvider.proto

Top

GetAirDataFileSetIdInput

FieldTypeLabelDescription
source string

operational bool

iso8601_timestamp string

GetAirDataFileSetIdOutput

FieldTypeLabelDescription
airdata_fileset_uuid string

status com.fss.grpc.globals.misc.RequestStatus

GetAirDataFileSetsInput

GetAirDataFileSetsOutput

FieldTypeLabelDescription
file_sets com.fss.grpc.globals.met.AirDataFileSet repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirDataInput

FieldTypeLabelDescription
points GetAirDataInput.AirDataPoint repeated

include_wind bool

include_temperature bool

include_isa_deviation bool

include_icing bool

include_shear bool

include_tropopause bool

enable_horizontal_interpolation bool

enable_vertical_interpolation bool

air_data_uuid string

GetAirDataInput.AirDataPoint

FieldTypeLabelDescription
iso8601_timestamp string

point com.fss.grpc.globals.nav.Point

altitude com.fss.grpc.globals.nav.Altitude

GetAirDataOutput

FieldTypeLabelDescription
data_sets com.fss.grpc.globals.met.AirData repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRouteFinderAirDataInput

FieldTypeLabelDescription
points GetRouteFinderAirDataInput.RouteFinderAirDataInputPoint repeated

include_icing bool

include_shear bool

min_altitude com.fss.grpc.globals.nav.Altitude

max_altitude com.fss.grpc.globals.nav.Altitude

altitude_step_count int32

air_data_uuid string

GetRouteFinderAirDataInput.RouteFinderAirDataInputPoint

FieldTypeLabelDescription
point com.fss.grpc.globals.nav.Point

iso8601_timestamp string

GetRouteFinderAirDataOutput

FieldTypeLabelDescription
data_sets GetRouteFinderAirDataOutput.ElevatedAirData repeated

Must have same length as input.points

altitudes float repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRouteFinderAirDataOutput.ElevatedAirData

FieldTypeLabelDescription
data_sets com.fss.grpc.globals.met.AirData repeated

Is empty if RouteFinderAirDataInputPoint parameters are invalid

AirDataProvider

Method NameRequest TypeResponse TypeDescription
GetAirData GetAirDataInput GetAirDataOutput

Accepts a list of points - returns the corresponding list of air data

GetRouteFinderAirData GetRouteFinderAirDataInput GetRouteFinderAirDataOutput

Accepts a list of points, min + max Altitude, stepSize

GetAirDataFileSetId GetAirDataFileSetIdInput GetAirDataFileSetIdOutput

Get a UUID for a AirdataFileSet - optional String Source, bool operational, Timestamp time

GetAirDataFileSets GetAirDataFileSetsInput GetAirDataFileSetsOutput

Get All AirdataFileSets including Metadata

aircraftPerformanceProvider/aircraftPerformanceProvider.proto

Top

GetAircraftTypesInput

FieldTypeLabelDescription
type_filter string

GetAircraftTypesOutput

FieldTypeLabelDescription
aircraft_type com.fss.grpc.globals.aircraft.AircraftType repeated

status com.fss.grpc.globals.misc.RequestStatus

GetClimbDataInput

FieldTypeLabelDescription
speed_schedule com.fss.grpc.globals.flight.SpeedSchedule

apu_burn_per_hour com.fss.grpc.globals.flight.Weight

fuel_bias float

anti_ice_fuel_bias float

air_conditioning_fuel_bias float

mel_cdl_fuel_bias float

other_fuel_bias float

take_off_elevation com.fss.grpc.globals.nav.Altitude

altitude_from com.fss.grpc.globals.nav.Altitude

altitude_to com.fss.grpc.globals.nav.Altitude

gross_weight com.fss.grpc.globals.flight.Weight

isa_deviation com.fss.grpc.globals.met.Temperature

wind_component com.fss.grpc.globals.flight.Speed

aircraft_performance_uuid string

GetClimbDataOutput

FieldTypeLabelDescription
time string

total_fuel com.fss.grpc.globals.flight.Weight

bias_fuel com.fss.grpc.globals.flight.Weight

anti_ice_fuel com.fss.grpc.globals.flight.Weight

apu_fuel com.fss.grpc.globals.flight.Weight

air_conditioning_fuel com.fss.grpc.globals.flight.Weight

mel_cdl_fuel com.fss.grpc.globals.flight.Weight

other_fuel com.fss.grpc.globals.flight.Weight

distance com.fss.grpc.globals.nav.Distance

status com.fss.grpc.globals.misc.RequestStatus

GetCruiseDataInput

FieldTypeLabelDescription
speed_schedule com.fss.grpc.globals.flight.SpeedSchedule

apu_burn_per_hour com.fss.grpc.globals.flight.Weight

fuel_bias float

anti_ice_fuel_bias float

air_conditioning_fuel_bias float

mel_cdl_fuel_bias float

other_fuel_bias float

altitude com.fss.grpc.globals.nav.Altitude

gross_weight com.fss.grpc.globals.flight.Weight

isa_deviation com.fss.grpc.globals.met.Temperature

wind_component com.fss.grpc.globals.flight.Speed

aircraft_performance_uuid string

GetCruiseDataOutput

FieldTypeLabelDescription
total_fuel com.fss.grpc.globals.flight.Weight

bias_fuel com.fss.grpc.globals.flight.Weight

anti_ice_fuel com.fss.grpc.globals.flight.Weight

apu_fuel com.fss.grpc.globals.flight.Weight

air_conditioning_fuel com.fss.grpc.globals.flight.Weight

mel_cdl_fuel com.fss.grpc.globals.flight.Weight

other_fuel com.fss.grpc.globals.flight.Weight

true_airspeed com.fss.grpc.globals.flight.Speed

status com.fss.grpc.globals.misc.RequestStatus

GetDescentDataInput

FieldTypeLabelDescription
speed_schedule com.fss.grpc.globals.flight.SpeedSchedule

apu_burn_per_hour com.fss.grpc.globals.flight.Weight

fuel_bias float

anti_ice_fuel_bias float

air_conditioning_fuel_bias float

mel_cdl_fuel_bias float

other_fuel_bias float

landing_elevation com.fss.grpc.globals.nav.Altitude

altitude_from com.fss.grpc.globals.nav.Altitude

altitude_to com.fss.grpc.globals.nav.Altitude

gross_weight com.fss.grpc.globals.flight.Weight

isa_deviation com.fss.grpc.globals.met.Temperature

wind_component com.fss.grpc.globals.flight.Speed

aircraft_performance_uuid string

GetDescentDataOutput

FieldTypeLabelDescription
time string

total_fuel com.fss.grpc.globals.flight.Weight

bias_fuel com.fss.grpc.globals.flight.Weight

anti_ice_fuel com.fss.grpc.globals.flight.Weight

apu_fuel com.fss.grpc.globals.flight.Weight

air_conditioning_fuel com.fss.grpc.globals.flight.Weight

mel_cdl_fuel com.fss.grpc.globals.flight.Weight

other_fuel com.fss.grpc.globals.flight.Weight

distance com.fss.grpc.globals.nav.Distance

status com.fss.grpc.globals.misc.RequestStatus

GetHoldDataInput

FieldTypeLabelDescription
flight_info com.fss.grpc.globals.flight.FlightInfo

altitude com.fss.grpc.globals.nav.Altitude

gross_weight com.fss.grpc.globals.flight.Weight

number_of_engines_inoperative int32

gear_down bool

aircraft_performance_uuid string

GetHoldDataOutput

FieldTypeLabelDescription
total_fuel_flow com.fss.grpc.globals.flight.Weight

anti_ice_fuel_flow com.fss.grpc.globals.flight.Weight

apu_fuel_flow com.fss.grpc.globals.flight.Weight

air_conditioning_fuel_flow com.fss.grpc.globals.flight.Weight

status com.fss.grpc.globals.misc.RequestStatus

GetMaximumAltitudeInput

FieldTypeLabelDescription
speed_schedule com.fss.grpc.globals.flight.SpeedSchedule

gross_weight com.fss.grpc.globals.flight.Weight

isa_deviation com.fss.grpc.globals.met.Temperature

wind_component com.fss.grpc.globals.flight.Speed

aircraft_performance_uuid string

GetMaximumAltitudeOutput

FieldTypeLabelDescription
altitude com.fss.grpc.globals.nav.Altitude

status com.fss.grpc.globals.misc.RequestStatus

GetMetaInfoInput

FieldTypeLabelDescription
filter string

GetMetaInfoOutput

FieldTypeLabelDescription
author string

version string

atc_designator string

aircraft_type string

aircraft_type_short string

engine_type string

engine_amount int32

pax_capacity int32

weight_unit com.fss.grpc.globals.flight.Weight.Units

equipment GetMetaInfoOutput.Equipment

min_max_values GetMetaInfoOutput.MinMaxValues

default_modes GetMetaInfoOutput.DefaultModes

default_weight_kg GetMetaInfoOutput.DefaultWeight

default_weight_lb GetMetaInfoOutput.DefaultWeight

erops_data GetMetaInfoOutput.EropsData

fuel_data_kg GetMetaInfoOutput.FuelData

fuel_data_lb GetMetaInfoOutput.FuelData

GetMetaInfoOutput.DefaultModes

FieldTypeLabelDescription
climb_mode com.fss.grpc.globals.flight.SpeedSchedule

cruise_mode com.fss.grpc.globals.flight.SpeedSchedule

descent_mode com.fss.grpc.globals.flight.SpeedSchedule

alternate_climb_mode com.fss.grpc.globals.flight.SpeedSchedule

alternate_cruise_mode com.fss.grpc.globals.flight.SpeedSchedule

alternate_descent_mode com.fss.grpc.globals.flight.SpeedSchedule

GetMetaInfoOutput.DefaultWeight

FieldTypeLabelDescription
dry_operating_weight com.fss.grpc.globals.flight.Weight

max_zero_fuel_weight com.fss.grpc.globals.flight.Weight

max_ramp_weight com.fss.grpc.globals.flight.Weight

max_take_off_weight com.fss.grpc.globals.flight.Weight

max_landing_weight com.fss.grpc.globals.flight.Weight

fuel_capacity com.fss.grpc.globals.flight.Weight

cargo_capacity com.fss.grpc.globals.flight.Weight

taxi_fuel_per_minute com.fss.grpc.globals.flight.Weight

apu_burn_per_hour com.fss.grpc.globals.flight.Weight

GetMetaInfoOutput.Equipment

FieldTypeLabelDescription
equipment string

transponder string

pbn string

nav string

com string

dat string

rmk string

wake_turbulence_category string

rvr string

per string

GetMetaInfoOutput.EropsData

FieldTypeLabelDescription
cruise_mode com.fss.grpc.globals.flight.SpeedSchedule

cruise_alt com.fss.grpc.globals.nav.Altitude

high_speed_descent_mode com.fss.grpc.globals.flight.SpeedSchedule

eo_high_speed_descent_mode com.fss.grpc.globals.flight.SpeedSchedule

eo_cruise_mode com.fss.grpc.globals.flight.SpeedSchedule

eo_descent_mode com.fss.grpc.globals.flight.SpeedSchedule

max_div_time string

GetMetaInfoOutput.FuelData

FieldTypeLabelDescription
fuel_capacity com.fss.grpc.globals.flight.Weight

taxi_fuel_per_minute com.fss.grpc.globals.flight.Weight

apu_burn_per_hour com.fss.grpc.globals.flight.Weight

engine_anti_ice_bias float

total_anti_ice_bias float

take_off_burn com.fss.grpc.globals.flight.Weight

landing_burn com.fss.grpc.globals.flight.Weight

take_off_time string

landing_time string

go_around_burn com.fss.grpc.globals.flight.Weight

GetMetaInfoOutput.MinMaxValues

FieldTypeLabelDescription
max_alt com.fss.grpc.globals.nav.Altitude

min_landing_runway_length com.fss.grpc.globals.nav.Distance

min_weight com.fss.grpc.globals.flight.Weight

max_weight com.fss.grpc.globals.flight.Weight

max_cost_index float

GetRouteFinderClimbMatrix

FieldTypeLabelDescription
isa_data GetRouteFinderClimbMatrix.IsaData repeated

GetRouteFinderClimbMatrix.IsaData

FieldTypeLabelDescription
isa_deviation float

wind_data GetRouteFinderClimbMatrix.IsaData.WindData repeated

GetRouteFinderClimbMatrix.IsaData.WindData

FieldTypeLabelDescription
wind_component float

weight_data GetRouteFinderClimbMatrix.IsaData.WindData.WeightData repeated

GetRouteFinderClimbMatrix.IsaData.WindData.WeightData

FieldTypeLabelDescription
weight com.fss.grpc.globals.flight.Weight

altitude_data GetRouteFinderClimbMatrix.IsaData.WindData.WeightData.AltitudeData repeated

GetRouteFinderClimbMatrix.IsaData.WindData.WeightData.AltitudeData

FieldTypeLabelDescription
altitude com.fss.grpc.globals.nav.Altitude

time string

fuel com.fss.grpc.globals.flight.Weight

distance com.fss.grpc.globals.nav.Distance

GetRouteFinderCruiseMatrix

FieldTypeLabelDescription
isa_data GetRouteFinderCruiseMatrix.IsaData repeated

GetRouteFinderCruiseMatrix.IsaData

FieldTypeLabelDescription
isa_deviation float

wind_data GetRouteFinderCruiseMatrix.IsaData.WindData repeated

GetRouteFinderCruiseMatrix.IsaData.WindData

FieldTypeLabelDescription
wind_component float

weight_data GetRouteFinderCruiseMatrix.IsaData.WindData.WeightData repeated

GetRouteFinderCruiseMatrix.IsaData.WindData.WeightData

FieldTypeLabelDescription
weight com.fss.grpc.globals.flight.Weight

altitude_data GetRouteFinderCruiseMatrix.IsaData.WindData.WeightData.AltitudeData repeated

max_altitude com.fss.grpc.globals.nav.Altitude

GetRouteFinderCruiseMatrix.IsaData.WindData.WeightData.AltitudeData

FieldTypeLabelDescription
altitude com.fss.grpc.globals.nav.Altitude

fuel_flow com.fss.grpc.globals.flight.Weight

true_airspeed com.fss.grpc.globals.flight.Speed

GetRouteFinderDescentMatrix

FieldTypeLabelDescription
isa_data GetRouteFinderDescentMatrix.IsaData repeated

GetRouteFinderDescentMatrix.IsaData

FieldTypeLabelDescription
isa_deviation float

wind_data GetRouteFinderDescentMatrix.IsaData.WindData repeated

GetRouteFinderDescentMatrix.IsaData.WindData

FieldTypeLabelDescription
wind_component float

weight_data GetRouteFinderDescentMatrix.IsaData.WindData.WeightData repeated

GetRouteFinderDescentMatrix.IsaData.WindData.WeightData

FieldTypeLabelDescription
weight com.fss.grpc.globals.flight.Weight

altitude_data GetRouteFinderDescentMatrix.IsaData.WindData.WeightData.AltitudeData repeated

GetRouteFinderDescentMatrix.IsaData.WindData.WeightData.AltitudeData

FieldTypeLabelDescription
altitude com.fss.grpc.globals.nav.Altitude

time string

fuel com.fss.grpc.globals.flight.Weight

distance com.fss.grpc.globals.nav.Distance

GetRouteFinderMatrixInput

FieldTypeLabelDescription
flight_info com.fss.grpc.globals.flight.FlightInfo

climb_altitude_step_size float

cruise_altitude_step_size float

descent_altitude_step_size float

compile_flight_info bool

GetRouteFinderMatrixOutput

FieldTypeLabelDescription
climb_matrix GetRouteFinderClimbMatrix

cruise_matrix GetRouteFinderCruiseMatrix

descent_matrix GetRouteFinderDescentMatrix

status com.fss.grpc.globals.misc.RequestStatus

AircraftPerformanceProvider

Method NameRequest TypeResponse TypeDescription
GetHoldData GetHoldDataInput GetHoldDataOutput

GetClimbData GetClimbDataInput GetClimbDataOutput

GetCruiseData GetCruiseDataInput GetCruiseDataOutput

GetDescentData GetDescentDataInput GetDescentDataOutput

GetMaximumAltitude GetMaximumAltitudeInput GetMaximumAltitudeOutput

GetRouteFinderMatrix GetRouteFinderMatrixInput GetRouteFinderMatrixOutput

GetMetaInfo GetMetaInfoInput GetMetaInfoOutput

GetAircraftTypes GetAircraftTypesInput GetAircraftTypesOutput

configProvider/configProvider.proto

Top

AddConfigInput

FieldTypeLabelDescription
config com.fss.grpc.globals.misc.Config

AddConfigOutput

FieldTypeLabelDescription
config com.fss.grpc.globals.misc.Config

status com.fss.grpc.globals.misc.RequestStatus

GetCategoriesInput

FieldTypeLabelDescription
filter string

GetCategoriesOutput

FieldTypeLabelDescription
category com.fss.grpc.globals.misc.ConfigCategory repeated

status com.fss.grpc.globals.misc.RequestStatus

GetConfigForKeyInput

FieldTypeLabelDescription
key string

include_meta_info bool

GetConfigForKeyOutput

FieldTypeLabelDescription
config com.fss.grpc.globals.misc.Config

status com.fss.grpc.globals.misc.RequestStatus

GetConfigsInput

FieldTypeLabelDescription
filter string

include_meta_info bool

GetConfigsOutput

FieldTypeLabelDescription
config com.fss.grpc.globals.misc.Config repeated

status com.fss.grpc.globals.misc.RequestStatus

GetPermissionGroupsInput

FieldTypeLabelDescription
filter string

GetPermissionGroupsOutput

FieldTypeLabelDescription
permission_group com.fss.grpc.globals.misc.ConfigPermissionGroup repeated

status com.fss.grpc.globals.misc.RequestStatus

RemoveConfigInput

FieldTypeLabelDescription
key string

RemoveConfigOutput

FieldTypeLabelDescription
status com.fss.grpc.globals.misc.RequestStatus

UpdateConfigDefinitionInput

FieldTypeLabelDescription
config com.fss.grpc.globals.misc.Config

UpdateConfigDefinitionOutput

FieldTypeLabelDescription
config com.fss.grpc.globals.misc.Config

status com.fss.grpc.globals.misc.RequestStatus

UpdateConfigInput

FieldTypeLabelDescription
key string

value string

UpdateConfigOutput

FieldTypeLabelDescription
key string

value string

status com.fss.grpc.globals.misc.RequestStatus

ConfigProvider

Method NameRequest TypeResponse TypeDescription
AddConfig AddConfigInput AddConfigOutput

UpdateConfig UpdateConfigInput UpdateConfigOutput

UpdateConfigDefinition UpdateConfigDefinitionInput UpdateConfigDefinitionOutput

RemoveConfig RemoveConfigInput RemoveConfigOutput

GetConfigs GetConfigsInput GetConfigsOutput

GetConfigForKey GetConfigForKeyInput GetConfigForKeyOutput

GetCategories GetCategoriesInput GetCategoriesOutput

GetPermissionGroups GetPermissionGroupsInput GetPermissionGroupsOutput

flightInfoCompiler/flightInfoCompiler.proto

Top

CompileFlightInfoOutput

FieldTypeLabelDescription
flight_info com.fss.grpc.globals.flight.FlightInfo

status com.fss.grpc.globals.misc.RequestStatus

FlightInfoCompiler

Method NameRequest TypeResponse TypeDescription
CompileFlightInfo .com.fss.grpc.globals.flight.FlightInfo CompileFlightInfoOutput

magneticVariationProvider/magneticVariationProvider.proto

Top

GetVariationInput

FieldTypeLabelDescription
iso8601_timestamp string

point com.fss.grpc.globals.nav.Point

GetVariationOutput

FieldTypeLabelDescription
angle com.fss.grpc.globals.nav.Angle

MagneticVariationProvider

Method NameRequest TypeResponse TypeDescription
GetVariation GetVariationInput GetVariationOutput

Top

BuildRouteInput

FieldTypeLabelDescription
flight_info com.fss.grpc.globals.flight.FlightInfo

route_string string

BuildRouteOutput

FieldTypeLabelDescription
route com.fss.grpc.globals.nav.Route

status com.fss.grpc.globals.misc.RequestStatus

FindAirportByIdentInput

FieldTypeLabelDescription
icao_or_iata string

include_runways bool

nav_data_uuid string

FindAirportByIdentOutput

FieldTypeLabelDescription
airport com.fss.grpc.globals.nav.Airport

status com.fss.grpc.globals.misc.RequestStatus

FindFirByIdentInput

FieldTypeLabelDescription
ident string

oceanic_fir bool

nav_data_uuid string

FindFirByIdentOutput

FieldTypeLabelDescription
flight_information_region com.fss.grpc.globals.nav.FlightInformationRegion

FindFirByPositionInput

FieldTypeLabelDescription
point com.fss.grpc.globals.nav.Point

altitude com.fss.grpc.globals.nav.Altitude

nav_data_uuid string

FindFirByPositionOutput

FieldTypeLabelDescription
flight_information_region com.fss.grpc.globals.nav.FlightInformationRegion

GetAirportsInput

FieldTypeLabelDescription
text_filter string

Text filter for ICAO/IATA code or Airport Name and/or location/radius List all airports, if filter is empty

country_code_filter string

reference_point com.fss.grpc.globals.nav.Point

radius double

include_runways bool

nav_data_uuid string

GetAirportsOutput

FieldTypeLabelDescription
airports com.fss.grpc.globals.nav.Airport repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirwayInput

FieldTypeLabelDescription
from_waypoint_unique_key string

to_waypoint_unique_key string

airway_name string

nav_data_uuid string

GetAirwayOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.Airway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirwaysInput

FieldTypeLabelDescription
origin_airport_icao string

origin_airport_runway string

origin_waypoint com.fss.grpc.globals.nav.Waypoint

destination_airport_icao string

destination_airport_runway string

destination_waypoint com.fss.grpc.globals.nav.Waypoint

area_size_factor double

area_size_additional_nautical_miles double

nav_data_uuid string

GetAirwaysOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.Airway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetDirectRouteSegmentInput

FieldTypeLabelDescription
nav_data_uuid string

from_point com.fss.grpc.globals.nav.Waypoint

to_point com.fss.grpc.globals.nav.Waypoint

GetDirectRouteSegmentOutput

FieldTypeLabelDescription
enroute_segment com.fss.grpc.globals.nav.Route.EnrouteSegment

status com.fss.grpc.globals.misc.RequestStatus

GetFirsInput

FieldTypeLabelDescription
fir_ident string

nav_data_uuid string

GetFirsOutput

FieldTypeLabelDescription
fir com.fss.grpc.globals.nav.FlightInformationRegion repeated

status com.fss.grpc.globals.misc.RequestStatus

GetGridMoraInput

FieldTypeLabelDescription
point com.fss.grpc.globals.nav.Point

point_to com.fss.grpc.globals.nav.Point

GetGridMoraOutput

FieldTypeLabelDescription
grid_mora com.fss.grpc.globals.nav.Altitude

status com.fss.grpc.globals.misc.RequestStatus

GetNavDataSetsInput

FieldTypeLabelDescription
iso8601_timestamp string

GetNavDataSetsOutput

FieldTypeLabelDescription
nav_datasets com.fss.grpc.globals.nav.NavDataSet repeated

status com.fss.grpc.globals.misc.RequestStatus

GetOutgoingAirwaysInput

FieldTypeLabelDescription
from_node_unique_key string

area_size_additional_nautical_miles double

nav_data_uuid string

GetOutgoingAirwaysOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.Airway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRouteFinderAirwaysInput

FieldTypeLabelDescription
from_point com.fss.grpc.globals.nav.Point

Can be ANY type

to_point com.fss.grpc.globals.nav.Point

flight_info com.fss.grpc.globals.flight.FlightInfo

area_size_factor double

area_size_additional_nautical_miles double

GetRouteFinderAirwaysOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.RouteFinderAirway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRunwaysInput

FieldTypeLabelDescription
airport_icao string

nav_data_uuid string

GetRunwaysOutput

FieldTypeLabelDescription
runways com.fss.grpc.globals.nav.Runway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetStandardInstrumentDepartureProcedureTransitionsInput

FieldTypeLabelDescription
airport_icao string

runway string

instrument_departure_procedure string

nav_data_uuid string

GetStandardInstrumentDepartureProcedureTransitionsOutput

FieldTypeLabelDescription
instrument_departure_procedures com.fss.grpc.globals.nav.TerminalProcedure repeated

status com.fss.grpc.globals.misc.RequestStatus

GetStandardInstrumentDepartureProceduresInput

FieldTypeLabelDescription
airport_ident string

runway string

procedure string

transition string

end_point_ident string

auto_up_number bool

nav_data_uuid string

GetStandardInstrumentDepartureProceduresOutput

FieldTypeLabelDescription
standard_instrument_departure_procedures com.fss.grpc.globals.nav.TerminalProcedure repeated

status com.fss.grpc.globals.misc.RequestStatus

GetStandardTerminalArrivalProceduresInput

FieldTypeLabelDescription
airport_ident string

runway string

procedure string

transition string

approach_type com.fss.grpc.globals.nav.ApproachType

approach_transition string

approach_designator string

initial_point_ident string

auto_up_number bool

nav_data_uuid string

GetStandardTerminalArrivalProceduresOutput

FieldTypeLabelDescription
standard_terminal_arrival_procedures com.fss.grpc.globals.nav.TerminalProcedure repeated

status com.fss.grpc.globals.misc.RequestStatus

GetWaypointsByAirwayInput

FieldTypeLabelDescription
waypoint_ident string

airway_name string

nav_data_uuid string

GetWaypointsByAirwayOutput

FieldTypeLabelDescription
waypoints com.fss.grpc.globals.nav.Waypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

GetWaypointsInput

FieldTypeLabelDescription
text_filter string

country_code_filter string

reference_point com.fss.grpc.globals.nav.Point

radius double

waypoint_type com.fss.grpc.globals.nav.Waypoint.Type

nav_data_uuid string

GetWaypointsOutput

FieldTypeLabelDescription
waypoints com.fss.grpc.globals.nav.Waypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

NavDataProvider

Method NameRequest TypeResponse TypeDescription
GetAirports GetAirportsInput GetAirportsOutput

GetRunways GetRunwaysInput GetRunwaysOutput

Returns a string list of available runways for a given airport

GetStandardInstrumentDepartureProcedures GetStandardInstrumentDepartureProceduresInput GetStandardInstrumentDepartureProceduresOutput

Returns a string list of all available Standard Instrument Departures (SIDs) for a given airport and runway

GetStandardTerminalArrivalProcedures GetStandardTerminalArrivalProceduresInput GetStandardTerminalArrivalProceduresOutput

GetStandardInstrumentDepartureProcedureTransitions GetStandardInstrumentDepartureProcedureTransitionsInput GetStandardInstrumentDepartureProcedureTransitionsOutput

Returns a string list of all available Standard Instrument Departures (SIDs) transitions for a given airport, runway and procedure

FindAirportByIdent FindAirportByIdentInput FindAirportByIdentOutput

GetWaypoints GetWaypointsInput GetWaypointsOutput

GetAirway GetAirwayInput GetAirwayOutput

GetAirways GetAirwaysInput GetAirwaysOutput

GetRouteFinderAirways GetRouteFinderAirwaysInput GetRouteFinderAirwaysOutput

GetFirs GetFirsInput GetFirsOutput

GetOutgoingAirways GetOutgoingAirwaysInput GetOutgoingAirwaysOutput

BuildRoute BuildRouteInput BuildRouteOutput

GetNavDataSets GetNavDataSetsInput GetNavDataSetsOutput

FindFirByPosition FindFirByPositionInput FindFirByPositionOutput

FindFirByIdent FindFirByIdentInput FindFirByIdentOutput

GetGridMora GetGridMoraInput GetGridMoraOutput

GetDirectRouteSegment GetDirectRouteSegmentInput GetDirectRouteSegmentOutput

GetWaypointsByAirway GetWaypointsByAirwayInput GetWaypointsByAirwayOutput

Top

GetAirportsInput

FieldTypeLabelDescription
airport_size GetAirportsInput.Size

nav_data_uuid string

GetAirportsOutput

FieldTypeLabelDescription
airport com.fss.grpc.globals.nav.Airport repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirwaysInput

FieldTypeLabelDescription
nav_data_uuid string

level com.fss.grpc.globals.nav.Airway.Level

include_low_airways bool

include_high_airways bool

include_directs bool

GetAirwaysOutput

FieldTypeLabelDescription
airways UiAirway repeated

waypoints UiWaypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRestrictiveAirspaceInput

FieldTypeLabelDescription
nav_data_uuid string

GetRestrictiveAirspaceOutput

FieldTypeLabelDescription
airspace com.fss.grpc.globals.nav.Airspace repeated

status com.fss.grpc.globals.misc.RequestStatus

GetWaypointsInput

FieldTypeLabelDescription
nav_data_uuid string

include_waypoints bool

include_navaids bool

include_terminal_waypoints_navaids bool

GetWaypointsOutput

FieldTypeLabelDescription
waypoints UiWaypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

UiAirway

FieldTypeLabelDescription
identifiers string repeated

type com.fss.grpc.globals.nav.Airway.RouteType

level com.fss.grpc.globals.nav.Airway.Level

from_point com.fss.grpc.globals.nav.Point

to_point com.fss.grpc.globals.nav.Point

UiWaypoint

FieldTypeLabelDescription
identifier string

name string

frequency string

point com.fss.grpc.globals.nav.Point

type com.fss.grpc.globals.nav.Waypoint.Type

is_terminal_waypoint bool

is_rnav_waypoint bool

GetAirportsInput.Size

NameNumberDescription
LARGE 0

MEDIUM 1

SMALL 2

NavDataProviderUi

Method NameRequest TypeResponse TypeDescription
GetAirports GetAirportsInput GetAirportsOutput

GetRestrictiveAirspace GetRestrictiveAirspaceInput GetRestrictiveAirspaceOutput

GetAirways GetAirwaysInput GetAirwaysOutput

GetWaypoints GetWaypointsInput GetWaypointsOutput

rawNavDataProvider/rawNavDataProvider.proto

Top

FindAirportByIdentInput

FieldTypeLabelDescription
icao_or_iata string

include_runways bool

nav_data_uuid string

FindAirportByIdentOutput

FieldTypeLabelDescription
airport com.fss.grpc.globals.nav.Airport

status com.fss.grpc.globals.misc.RequestStatus

FindFirByIdentInput

FieldTypeLabelDescription
ident string

oceanic_fir bool

nav_data_uuid string

FindFirByIdentOutput

FieldTypeLabelDescription
flight_information_region com.fss.grpc.globals.nav.FlightInformationRegion

status com.fss.grpc.globals.misc.RequestStatus

FindFirByPositionInput

FieldTypeLabelDescription
point com.fss.grpc.globals.nav.Point

altitude com.fss.grpc.globals.nav.Altitude

nav_data_uuid string

FindFirByPositionOutput

FieldTypeLabelDescription
flight_information_region com.fss.grpc.globals.nav.FlightInformationRegion

GetAirportsInput

FieldTypeLabelDescription
text_filter string

Text filter for ICAO/IATA code or Airport Name and/or location/radius List all airports, if filter is empty

country_code_filter string

reference_point com.fss.grpc.globals.nav.Point

radius float

include_runways bool

nav_data_uuid string

GetAirportsOutput

FieldTypeLabelDescription
airports com.fss.grpc.globals.nav.Airport repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirwayInput

FieldTypeLabelDescription
from_waypoint_unique_key string

to_waypoint_unique_key string

airway_name string

nav_data_uuid string

GetAirwayOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.Airway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirwaysInput

FieldTypeLabelDescription
origin_airport_icao string

origin_airport_runway string

origin_waypoint com.fss.grpc.globals.nav.Waypoint

destination_airport_icao string

destination_airport_runway string

destination_waypoint com.fss.grpc.globals.nav.Waypoint

area_size_factor float

area_size_additional_nautical_miles float

nav_data_uuid string

GetAirwaysOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.Airway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetCruisingTableInput

FieldTypeLabelDescription
from_point com.fss.grpc.globals.nav.Point

to_point com.fss.grpc.globals.nav.Point

nav_data_uuid string

GetCruisingTableOutput

FieldTypeLabelDescription
cruising_table com.fss.grpc.globals.nav.CruisingTable

status com.fss.grpc.globals.misc.RequestStatus

GetFirsInput

FieldTypeLabelDescription
fir_ident string

nav_data_uuid string

GetFirsOutput

FieldTypeLabelDescription
fir com.fss.grpc.globals.nav.FlightInformationRegion repeated

status com.fss.grpc.globals.misc.RequestStatus

GetGridMoraInput

FieldTypeLabelDescription
point com.fss.grpc.globals.nav.Point

point_to com.fss.grpc.globals.nav.Point

GetGridMoraOutput

FieldTypeLabelDescription
grid_mora com.fss.grpc.globals.nav.Altitude

status com.fss.grpc.globals.misc.RequestStatus

GetNavDataSetsInput

FieldTypeLabelDescription
iso8601_timestamp string

GetNavDataSetsOutput

FieldTypeLabelDescription
nav_datasets com.fss.grpc.globals.nav.NavDataSet repeated

status com.fss.grpc.globals.misc.RequestStatus

GetOutgoingAirwaysInput

FieldTypeLabelDescription
from_node_unique_key string

area_size_additional_nautical_miles double

nav_data_uuid string

GetOutgoingAirwaysOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.Airway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRouteFinderAirwaysInput

FieldTypeLabelDescription
from_point com.fss.grpc.globals.nav.Point

to_point com.fss.grpc.globals.nav.Point

area_size_factor float

area_size_additional_nautical_miles float

nav_data_uuid string

GetRouteFinderAirwaysOutput

FieldTypeLabelDescription
airways com.fss.grpc.globals.nav.RouteFinderAirway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRunwaysInput

FieldTypeLabelDescription
airport_icao string

nav_data_uuid string

GetRunwaysOutput

FieldTypeLabelDescription
runways com.fss.grpc.globals.nav.Runway repeated

status com.fss.grpc.globals.misc.RequestStatus

GetStandardInstrumentDepartureProcedureTransitionsInput

FieldTypeLabelDescription
airport_icao string

runway string

instrument_departure_procedure string

nav_data_uuid string

GetStandardInstrumentDepartureProcedureTransitionsOutput

FieldTypeLabelDescription
instrument_departure_procedures com.fss.grpc.globals.nav.TerminalProcedure repeated

status com.fss.grpc.globals.misc.RequestStatus

GetStandardInstrumentDepartureProceduresInput

FieldTypeLabelDescription
airport_ident string

runway string

procedure string

transition string

end_point_ident string

auto_up_number bool

nav_data_uuid string

GetStandardInstrumentDepartureProceduresOutput

FieldTypeLabelDescription
standard_instrument_departure_procedures com.fss.grpc.globals.nav.TerminalProcedure repeated

status com.fss.grpc.globals.misc.RequestStatus

GetStandardTerminalArrivalProceduresInput

FieldTypeLabelDescription
airport_ident string

runway string

procedure string

transition string

approach_type com.fss.grpc.globals.nav.ApproachType

approach_transition string

approach_designator string

initial_point_ident string

auto_up_number bool

nav_data_uuid string

GetStandardTerminalArrivalProceduresOutput

FieldTypeLabelDescription
standard_terminal_arrival_procedures com.fss.grpc.globals.nav.TerminalProcedure repeated

status com.fss.grpc.globals.misc.RequestStatus

GetWaypointsByAirwayInput

FieldTypeLabelDescription
waypoint_ident string

airway_name string

nav_data_uuid string

GetWaypointsByAirwayOutput

FieldTypeLabelDescription
waypoints com.fss.grpc.globals.nav.Waypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

GetWaypointsInput

FieldTypeLabelDescription
waypoint_ident string

country_code_filter string

reference_point com.fss.grpc.globals.nav.Point

radius float

waypoint_type com.fss.grpc.globals.nav.Waypoint.Type

nav_data_uuid string

GetWaypointsOutput

FieldTypeLabelDescription
waypoints com.fss.grpc.globals.nav.Waypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

RawNavDataProvider

Method NameRequest TypeResponse TypeDescription
GetAirports GetAirportsInput GetAirportsOutput

GetRunways GetRunwaysInput GetRunwaysOutput

Returns a string list of available runways for a given airport

GetStandardInstrumentDepartureProcedureTransitions GetStandardInstrumentDepartureProcedureTransitionsInput GetStandardInstrumentDepartureProcedureTransitionsOutput

Returns a string list of all available Standard Instrument Departures (SIDs) for a given airport and runway Returns a string list of all available Standard Instrument Departures (SIDs) transitions for a given airport, runway and procedure

FindAirportByIdent FindAirportByIdentInput FindAirportByIdentOutput

GetStandardInstrumentDepartureProcedures GetStandardInstrumentDepartureProceduresInput GetStandardInstrumentDepartureProceduresOutput

GetStandardTerminalArrivalProcedures GetStandardTerminalArrivalProceduresInput GetStandardTerminalArrivalProceduresOutput

GetWaypoints GetWaypointsInput GetWaypointsOutput

GetWaypointsByAirway GetWaypointsByAirwayInput GetWaypointsByAirwayOutput

GetAirway GetAirwayInput GetAirwayOutput

GetAirways GetAirwaysInput GetAirwaysOutput

GetRouteFinderAirways GetRouteFinderAirwaysInput GetRouteFinderAirwaysOutput

GetFirs GetFirsInput GetFirsOutput

GetOutgoingAirways GetOutgoingAirwaysInput GetOutgoingAirwaysOutput

GetCruisingTable GetCruisingTableInput GetCruisingTableOutput

GetNavDataSets GetNavDataSetsInput GetNavDataSetsOutput

FindFirByPosition FindFirByPositionInput FindFirByPositionOutput

FindFirByIdent FindFirByIdentInput FindFirByIdentOutput

GetGridMora GetGridMoraInput GetGridMoraOutput

rawNavDataProviderUi/rawNavDataProviderUi.proto

Top

GetAirportsInput

FieldTypeLabelDescription
min_runway_length com.fss.grpc.globals.nav.Distance

max_runway_length com.fss.grpc.globals.nav.Distance

nav_data_uuid string

GetAirportsOutput

FieldTypeLabelDescription
airport com.fss.grpc.globals.nav.Airport repeated

status com.fss.grpc.globals.misc.RequestStatus

GetAirwaysInput

FieldTypeLabelDescription
nav_data_uuid string

level com.fss.grpc.globals.nav.Airway.Level

include_directs bool

include_waypoints bool

GetAirwaysOutput

FieldTypeLabelDescription
airways UiAirway repeated

waypoints UiWaypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

GetRestrictiveAirspaceInput

FieldTypeLabelDescription
nav_data_uuid string

GetRestrictiveAirspaceOutput

FieldTypeLabelDescription
airspace com.fss.grpc.globals.nav.Airspace repeated

status com.fss.grpc.globals.misc.RequestStatus

GetWaypointsInput

FieldTypeLabelDescription
nav_data_uuid string

include_waypoints bool

include_navaids bool

include_terminal_waypoints_navaids bool

GetWaypointsOutput

FieldTypeLabelDescription
waypoints UiWaypoint repeated

status com.fss.grpc.globals.misc.RequestStatus

UiAirway

FieldTypeLabelDescription
identifiers string repeated

type com.fss.grpc.globals.nav.Airway.RouteType

level com.fss.grpc.globals.nav.Airway.Level

from_point com.fss.grpc.globals.nav.Point

to_point com.fss.grpc.globals.nav.Point

UiWaypoint

FieldTypeLabelDescription
identifier string

name string

frequency string

point com.fss.grpc.globals.nav.Point

type com.fss.grpc.globals.nav.Waypoint.Type

is_terminal_waypoint bool

is_rnav_waypoint bool

RawNavDataProviderUi

Method NameRequest TypeResponse TypeDescription
GetAirports GetAirportsInput GetAirportsOutput

GetRestrictiveAirspace GetRestrictiveAirspaceInput GetRestrictiveAirspaceOutput

GetAirways GetAirwaysInput GetAirwaysOutput

GetWaypoints GetWaypointsInput GetWaypointsOutput

rawNotamProvider/rawNotamProvider.proto

Top

GetAllNotamsInput

FieldTypeLabelDescription
point com.fss.grpc.globals.nav.Point

GetAllNotamsOutput

FieldTypeLabelDescription
text string

status com.fss.grpc.globals.misc.RequestStatus

RawNotamProvider

Method NameRequest TypeResponse TypeDescription
GetAllNotams GetAllNotamsInput GetAllNotamsOutput

restrictionManager/restrictionManager.proto

Top

GetRestrictionsInput

FieldTypeLabelDescription
airport_icao string repeated

airway_identifier string repeated

GetRestrictionsOutput

FieldTypeLabelDescription
flight_restrictions com.fss.grpc.globals.nav.FlightRestriction repeated

status com.fss.grpc.globals.misc.RequestStatus

RestrictionManager

Method NameRequest TypeResponse TypeDescription
GetRestrictions GetRestrictionsInput GetRestrictionsOutput

Accepts a list of airports, airways, waypoints - returns the corresponding list of restrictions

routeCalculator/routeCalculator.proto

Top

CalculateRouteFromStringInput

FieldTypeLabelDescription
block_fuel com.fss.grpc.globals.flight.Weight

flight_info com.fss.grpc.globals.flight.FlightInfo

route_string string

CalculateRouteFromStringOutput

FieldTypeLabelDescription
calculated_route com.fss.grpc.globals.nav.CalculatedRoute

status com.fss.grpc.globals.misc.RequestStatus

CalculateRouteInput

FieldTypeLabelDescription
flight_info com.fss.grpc.globals.flight.FlightInfo

route com.fss.grpc.globals.nav.Route

CalculateRouteOutput

FieldTypeLabelDescription
output string

status com.fss.grpc.globals.misc.RequestStatus

RouteCalculatorService

Method NameRequest TypeResponse TypeDescription
CalculateRoute CalculateRouteInput CalculateRouteOutput

CalculateRouteFromString CalculateRouteFromStringInput CalculateRouteFromStringOutput

routeFinder/routeFinder.proto

Top

BuildRouteInput

FieldTypeLabelDescription
flight_info com.fss.grpc.globals.flight.FlightInfo

route_string string

BuildRouteOutput

FieldTypeLabelDescription
route com.fss.grpc.globals.nav.Route

status com.fss.grpc.globals.misc.RequestStatus

RouteFinderInput

FieldTypeLabelDescription
origin_waypoint com.fss.grpc.globals.nav.Waypoint

destination_waypoint com.fss.grpc.globals.nav.Waypoint

weight_at_origin_waypoint com.fss.grpc.globals.flight.Weight

altitude_at_origin_waypoint com.fss.grpc.globals.nav.Altitude

time_at_origin_waypoint string

flight_info com.fss.grpc.globals.flight.FlightInfo

RouteFinderOutput

FieldTypeLabelDescription
route com.fss.grpc.globals.nav.Route

route_string string

status com.fss.grpc.globals.misc.RequestStatus

RouteFinder

Method NameRequest TypeResponse TypeDescription
FindRoute RouteFinderInput RouteFinderOutput

BuildRoute BuildRouteInput BuildRouteOutput

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)