API Reference Manual

Table Of Contents:

• 1 API Reference
• 1.1 HTTPS Communication and OAuth2 Authentication
• 1.2 API End Points
• 1.2.1 /token
• 1.2.2 /api/v1/logout
• 1.2.3 /healthcheck
• 1.2.4 /api/v1/user
• 1.2.5 /api/v1/users
• 1.2.6 /api/v1/mnclist
• 1.2.7 /api/v1/activebackend
• 1.2.8 /api/v1/peek
• 1.2.9 /api/v1/poke
• 1.2.10 /api/v1/makewebsocket
• 1.2.11 /api/v1/subscribe
• 1.2.12 /api/v1/uscreens
• 1.2.13 /api/v1/dscreens
• 1.2.14 /api/v1/dframes
• 1.2.15 /api/v1/macros
• 1.2.16 /api/v1/playmacro
• 1.2.17 /api/v1/presets
• 1.2.18 /api/v1/applypreset
• 1.2.19 /api/v1/collectpreset
• 1.2.20 /api/v1/presetvars
• 1.2.21 /api/v1/devicevars
• 1.2.22 /api/v1/schedule
• 1.2.23 /api/v1/healthcheck
• 1.2.24 /api/v1/dbstate
• 1.2.25 /api/v1/dbversion
• 1.2.26 /api/v1/satellites
• 1.2.27 /api/v1/satoperators
• 1.2.28 /api/v1/channels
• 1.2.29 /api/v1/streamkeys
• 1.2.30 /api/v1/antennas
• 1.2.31 /api/v1/satdetails
• 1.2.32 /api/v1/tleimport
• 1.2.33 /api/v1/eventreport
• 1.2.34 /api/v1/eventack
• 1.2.35 /api/v1/trackmem
• 1.2.36 /api/v1/treeview
• 1.2.37 /api/v1/debug
• 1.2.38 /api/v1/redundancy
• 1.2.39 /api/v1/restart
• 1.2.40 /api/v1/devicesetup
• 1.2.41 /api/v1/drivers
• 1.2.42 /api/v1/protocols
• 1.2.43 /api/v1/preferredprotocols
• 1.2.44 /api/v1/filerecordings
• 1.2.45 /api/v1/filerecordersettings
• 1.2.46 /api/v1/acutargets
• 1.2.47 /api/v1/inventory
• 1.2.48 /api/v1/documents
• 1.2.49 /api/v1/thumbnail
• 1.2.50 /api/v1/backendinfo
• 1.2.51 /api/v1/globalSettings
• 1.2.52 /api/v1/userSettings
• 1.2.53 /api/v1/recordeddata
• 1.3 WebSocket Communication
• 1.3.1 Creating WebSockets
• 1.3.2 Subscribing For Messages
• 1.3.3 Interpreting WebSocket Data
• 1.3.4 Echo / Heartbeat Function
• 1.3.5 Closing Websockets
• 1.4 Debug Terminal Communication
• 1.4.1 Opening A Debug Terminal
• 1.4.2 Closing A Debug Terminal
• 1.4.3 Sending Debug Commands
• 1.4.4 M&C Redundancy Management
• 1.5 Data Models
• 1.5.1 TokenReply
• 1.5.2 UserProperties
• 1.5.3 UserList
• 1.5.4 ApiError
• 1.5.5 MncList
• 1.5.6 MncInfo
• 1.5.7 ActiveBackend
• 1.5.8 SubscribeList
• 1.5.9 WebsocketId
• 1.5.10 Message
• 1.5.11 Parameter
• 1.5.12 Range
• 1.5.13 StringRange
• 1.5.14 IntegerRange
• 1.5.15 HexRange
• 1.5.16 DoubleRange
• 1.5.17 BooleanRange
• 1.5.18 AlarmFlagRange
• 1.5.19 EnumRange
• 1.5.20 ObjectRange
• 1.5.21 SpectrumTrace
• 1.5.22 TrackingPoint
• 1.5.23 TrackingHistory
• 1.5.24 EventLog
• 1.5.25 EventReport
• 1.5.26 EventReportRequest
• 1.5.27 EventAck
• 1.5.28 EventInfo
• 1.5.29 FaultList
• 1.5.30 FaultInfo
• 1.5.31 DeviceFrameDefinition
• 1.5.32 DeviceFrameTab
• 1.5.33 ScreenDefinition
• 1.5.34 ScreenElement
• 1.5.35 ArrowElement
• 1.5.36 ButtonElement
• 1.5.37 ChartElement
• 1.5.38 AzElElement
• 1.5.39 DeviceElement
• 1.5.40 DisplayElement
• 1.5.41 EditButtonElement
• 1.5.42 FaultElement
• 1.5.43 FrameElement
• 1.5.44 GaugeElement
• 1.5.45 IconElement
• 1.5.46 LatchingButtonElement
• 1.5.47 LockButtonElement
• 1.5.48 MCPElement
• 1.5.49 ParameterButtonElement
• 1.5.50 ParameterElement
• 1.5.51 RadioButtonElement
• 1.5.52 RectElement
• 1.5.53 SpectrumElement
• 1.5.54 SwitchElement
• 1.5.55 TakeButtonElement
• 1.5.56 TargetListElement
• 1.5.57 TextElement
• 1.5.58 ThumbnailElement
• 1.5.59 XYChartElement
• 1.5.60 ColorDefinition
• 1.5.61 ItemList
• 1.5.62 Macro
• 1.5.63 PresetValue
• 1.5.64 DevicePreset
• 1.5.65 PresetVars
• 1.5.66 DeviceVars
• 1.5.67 KeyValPair
• 1.5.68 Dictionary
• 1.5.69 SatDbSatellite
• 1.5.70 SatDbBeaconAttenuation
• 1.5.71 SatDbBeacon
• 1.5.72 SatDbTcAttenuation
• 1.5.73 SatDbTc
• 1.5.74 SatDbTmAttenuation
• 1.5.75 SatDbTm
• 1.5.76 SatDbSatOperator
• 1.5.77 SatDbPosition
• 1.5.78 SatDbAntenna
• 1.5.79 SatDbTLEData
• 1.5.80 SatDbI11Data
• 1.5.81 SatDbTableTracking
• 1.5.82 SatDbSatDetails
• 1.5.83 SatDbTleImport
• 1.5.84 SatDbState
• 1.5.85 ChannelData
• 1.5.86 StreamKeyData
• 1.5.87 TreeViewNode
• 1.5.88 DatabaseVersion
• 1.5.89 DebugMessage
• 1.5.90 RedundancyState
• 1.5.91 RedundancySummary
• 1.5.92 RedundancyCmd
• 1.5.93 RestartCmd
• 1.5.94 ScheduleEvent
• 1.5.95 Schedule
• 1.5.96 DeviceDefinition
• 1.5.97 DeviceThreadDefinition
• 1.5.98 DeviceSetup
• 1.5.99 FRViewProperties
• 1.5.100 FRViewTraceDescription
• 1.5.101 FRViewPreset
• 1.5.102 FRViewTraceScaling
• 1.5.103 AcuTarget
• 1.5.104 AcuTargetList
• 1.5.105 InventoryItem
• 1.5.106 InventoryDevice
• 1.5.107 InventoryLogEntry
• 1.5.108 DocumentItem
• 1.5.109 DocumentList
• 1.5.110 Thumbnail
• 1.5.111 BackendInfo
• 1.5.112 UISettings
• 1.5.113 RecorderQuery
• 1.5.114 RecorderDataPoint
• 1.5.115 RecorderData
• 1.6 Satellite Database
• 1.6.1 Table Satellites (satellites)
• 1.6.2 Table Satellite Operators (satellites_operators)
• 1.6.3 Antennas (antennas)
• 1.6.4 Table Satellite Beacons (satellite_beacons)
• 1.6.5 Table Satellite TC (satellite_tc)
• 1.6.6 Table Satellite TM (satellite_tm)
• 1.6.7 Table Satellite Positions (satellite_positions)
• 1.6.8 Table Table Tracking (table_tracking)
• 1.6.9 Table Intelsat 11 Parameters (intelsat_11parameters)
• 1.6.10 Table Norad TLE (norad_tle)
• 1.6.11 Table Channels (channels)
• 1.6.12 Table StreamKeys (stream_keys)
• 1.6.13 Table BeaconAttenuations (beacon_attenuations)
• 1.6.14 Table TcAttenuations (tc_attenuations)
• 1.6.15 Table TmAttenuations (tm_attenuations)
• 1.6.16 Table InventoryItems (inventory_items)
• 1.6.17 Table InventoryDevices (inventory_devices)
• 1.6.18 Table InventoryLog (inventory_log)
• 1.6.19 Table Documents (documents)
• 1.6.20 Table GlobalSettings (globalSettings)
• 1.6.21 Table User Settings (userSettings)
• 1.7 Fonts