Documentation Formats

 

ServerConfig.json

This JSON file carries the server configuration settings to the web site.

Request

The address of the JSON file is http://<site-address>/VirtualRadar/ServerConfig.json. There are no query string parameters. The AircraftList.json feed can be used to tell you when the server configuration has been changed since the last fetch.

Response

Property Type Description
GoogleMapsApiKey String The API key to use when sending a request to Google for the Google Maps JavaScript. If this is null or empty then no key is required.
InitialDistanceUnit String The initial distance unit - km = kilometres, sm = statute miles, nm = nautical miles.
InitialHeightUnit String The initial height unit - f = feet, m = metres.
InitialLatitude Number The latitude for the initial current position.
InitialLongitude Number The longitude for the initial current position.
InitialMapType String The initial map type - h = hybrid, m = road map, t = terrain, s = satellite, o = contrast.
InitialSpeedUnit String The initial speed unit - km = kilometres/hour, kt = knots, ml = statute miles/hour.
InitialZoom Number The initial map zoom level.
InternetClientCanRunReports Boolean True if Internet clients can run reports.
InternetClientCanShowPinText Boolean True if Internet clients can show text to aircraft markers.
InternetClientsCanPlayAudio Boolean True if Internet clients can use the audio features of the site.
InternetClientsCanSubmitRoutes Boolean True if Internet clients can see the submit route links.
InternetClientsCanSeeAircraftPictures Boolean True if Internet clients can see pictures.
InternetClientsCanSeePolarPlots Boolean True if Internet clients can see receiver range plots.
InternetClientTimeoutMinutes Number The number of minutes an Internet client can remain idle before the site times out. 0 disables the site timeout.
IsAudioEnabled Boolean True if the audio features are available and have been enabled on the server.
IsLocalAddress Boolean True if the server believes the request came from a machine on the LAN, false if it thinks the request came from the Internet.
IsMono Boolean True if the server is running under Mono.
MinimumRefreshSeconds Number The lowest acceptable interval in seconds between refreshes.
RefreshSeconds Number The default interval in seconds between refreshes.
VrsVersion String The version number of the server.
UseMarkerLabels Boolean True if marker labels are to be used instead of drawing lines of text onto the marker images.
Receivers Array An array of objects describing every available feed. The object is of the form { id: number, name: string }.