FG Tracker & Planner

 Terminology

Archive

Data which was placed to another place for permanent storage. If the functions have a boolean “is_archive” return, the developer shall indicate via GET Parameter on whether he wants the functions return current data or archived data.

Duration/
Flight time

Duration from the pilot enters the FGMS network to the pilot exits the FGMS network. Not recommend to be used for public views. Use effective flight time instead.

Effective flight time

Sum of time the aircraft movement > 5knots in the session/in any session.

Array (PHP: $reply=json_decode( file_get_contents(URL), true))

Type

Description

$reply["header"]["code"]

Int

Code of status/Error code (see below)

$reply["header"]["msg"]

String

Message from server

$reply["header"]["request_time"]

String

Time on server when the request is received

$reply["header"]["request_time_raw"]

int

Time on server when the request is received (since Unix epoch)

$reply["header"]["process_time"]

Float

Time used in processing the request in second

$reply["header"]["request_ip"]

char

Client IP. This IP can be force casting by GET Parameter “&ip=<IP>”

$reply["header"]["request_location"]

char

Location of client IP [ISO 3166-1 Alpha 2 country code. Data provided by GeoLite data created by MaxMind, available from http://www.maxmind.com (IPv4 only), or Cloudflare IP Geolocation(IPv4 and IPv6)].  NULL if the location cannot be identified.  This location determines the time zone present in the data reply. To force casting the location, add &clientlocation=<location>  in GET Parameter

$reply["header"]["request_location_name"]

char

Full name of request location

$reply["header"]["request_timezone"]

char

Default time zone set by interface. To force casting the time zone, add &timezone=0  in GET Parameter

$reply["header"]["request_timezone_abbr"]

Char

Code

Description

200

Request fulfilled and returned

400

Bad request. Some necessary parameters not defined

404

Request return nil result (Note the data section will not be set)

500

Internal server error. Contact administrator for fixing

Array (PHP: $reply=json_decode( file_get_contents(URL), true))

Type

Description

GET Parameter

$reply["data"]["callsign"]

String

Callsign

&callsign=<String callsign>

$reply["data"]["status"]

String

Callsign status:
Not registered – The callsign is not yet registered
Registered – The callsign is registered but not yet pass email verification
Active – The callsign is registered and passed email verification
Deactivated – This callsign is deactivated
Protected – This callsign is protected from being registered
Dispute – A person has filed a dispute on this callsign

N/A

$reply["data"]["other_callsigns"][]

String

Other activated callsigns by the same pilot. Missing if no other activated callsigns, or $reply["data"]["status"] not equal to "Active".

N/A

$reply["data"]["is_archive"]

boolean

"true" if the request is requesting archived data
"false" if the request is requesting current data

&archive=true
&archive=false (default)

If $reply["data"]["status"]==”Disput”, Json reply ends here.

$reply["data"]["no_of_flights"]

int

Number of flights in current/archive flight list

N/A

$reply["data"]["flight_list_offset"]

int

Offset of the flight list. If offset > number of flights, offset=0

&offset=<int offset> (default=0)

$reply["data"]["rank"]

int

Rank (according to effective flight time)

N/A

$reply["data"]["lastweek"]

String

Total flight time in last 7 days

N/A

$reply["data"]["lastweek_raw"]

int

Total flight time in last 7 days in seconds

N/A

$reply["data"]["last30days"]

String

Total flight time in last 30 days

N/A

$reply["data"]["last30days_raw"]

int

Total flight time in last 30 days in seconds

N/A

$reply["data"]["total_flight_time"]

String

Total flight time all time

N/A

$reply["data"]["total_flight_time_raw"]

int

Total flight time all time in seconds

N/A

$reply["data"]["effective_flight_time"]

String

Total effective flight time all time

N/A

$reply["data"]["effective_flight_time_raw"]

int

Total effective flight time all time in seconds

N/A

$reply["data"]["db_archive_date"]

Date

(YYYY-MM-DD)Database archive date (i.e. flight data before this date is archived)

N/A

$reply["data"]["flight_time_by_type"]

Array

Summary report per aircraft for <callsign>

N/A

$reply["data"]["flight_time_by_type"][]["model"]

String

Aircraft model in human readable format. NULL if no such information in FGTracker

N/A

$reply["data"]["flight_time_by_type"][]["model_raw"]

String

Aircraft model in “--aircraft” format

N/A

$reply["data"]["flight_time_by_type"][]["duration"]

String

Total flight duration of that model

N/A

$reply["data"]["flight_time_by_type"][]["duration_raw"]

int

Total flight duration of that model in seconds

N/A

$reply["data"]["flight_time_by_type"][]["effective_flight_time"]

String

Total effective flight time of that model

N/A

$reply["data"]["flight_time_by_type"][]["effective_flight_time_raw"]

int

Total effective flight time of that model in seconds

N/A

$reply["data"]["start_icaos"]

Array

Airports the pilot visits (as departure airports), order by counts

N/A

$reply["data"]["start_icaos"][]["icao"]

String

ICAO name of the departure airport. “----” if location is not an airport

N/A

$reply["data"]["start_icaos"][]["icao_name"]

String

Name of the departure airport. “Unknown” if location is not an airport

N/A

$reply["data"]["start_icaos"][]["country"]

String

Country of the departure airport. NULL if location is not an airport or country cannot be identified

N/A

$reply["data"]["start_icaos"][]["counts"]

Int

No of times visited

N/A

$reply["data"]["end_icaos"]

Array

Airports the pilot visits (as departure airports), order by counts

N/A

$reply["data"]["end_icaos"][]["icao"]

String

ICAO name of the arrival airport. “----” if location is not an airport

N/A

$reply["data"]["end_icaos"][]["icao_name"]

String

Name of the arrival airport. “Unknown” if location is not an airport

N/A

$reply["data"]["end_icaos"][]["country"]

String

Country of the arrival airport. NULL if location is not an airport or country cannot be identified

N/A

$reply["data"]["end_icaos"][]["counts"]

Int

No of times visited

N/A

$reply["data"]["flight_list"]

Array

Flight list in current/archive result set (100 results after offset)

N/A

$reply["data"]["flight_list"][]["row"]

int

Row id in current/archive result set

N/A

$reply["data"]["flight_list"][]["id"]

int

Flight id in DB

N/A

$reply["data"]["flight_list"][]["callsign"]

String

Callsign

N/A

$reply["data"]["flight_list"][]["model"]

String

Aircraft model in human readable format. NULL if no such information in FGTracker

N/A

$reply["data"]["flight_list"][]["model_raw"]

String

Aircraft model in “--aircraft” format

N/A

$reply["data"]["flight_list"][]["start_time"]

String

Flight start time

N/A

$reply["data"]["flight_list"][]["start_time_raw"]

int

Flight start time in seconds (since Unix epoch)

N/A

$reply["data"]["flight_list"][]["start_location"]["icao"]

String

ICAO name of the departure airport. “----” if location is not an airport. NULL if data not yet been updated

N/A

$reply["data"]["flight_list"][]["start_location"]["icao_name"]

String

Name of the departure airport. “Unknown” if location is not an airport. NULL if data not yet been updated

N/A

$reply["data"]["flight_list"][]["start_location"]["country"]

String

Country of the departure airport. NULL if location is not an airport or country cannot be identified

N/A

$reply["data"]["flight_list"][]["end_time"]

String

Flight end time

N/A

$reply["data"]["flight_list"][]["end_time_raw"]

int

Flight end time in seconds (since Unix epoch)

N/A

$reply["data"]["flight_list"][]["end_location"]["icao"]

String

ICAO name of the arrival airport. “----” if location is not an airport. NULL if data not yet been updated

N/A

$reply["data"]["flight_list"][]["end_location"]["icao_name"]

String

Name of the arrival airport. “Unknown” if location is not an airport. NULL if data not yet been updated

N/A

$reply["data"]["flight_list"][]["end_location"]["country"]

String

Country of the arrival airport. NULL if location is not an airport or country cannot be identified

N/A

$reply["data"]["flight_list"][]["duration"]

String

Flight duration

N/A

$reply["data"]["flight_list"][]["duration_raw"]

int

Flight duration in seconds

N/A

$reply["data"]["flight_list"][]["numwpts"]

int

Number of way points

N/A

$reply["data"]["flight_list"][]["effective_flight_time"]

String

Effective flight time

N/A

$reply["data"]["flight_list"][]["effective_flight_time_raw"]

int

Effective flight time in seconds

N/A

$reply["data"]["log"]

Array

Array of logs. NULL if no data

N/A

$reply["data"]["log"][]["operating_user"]

String

Origin (Username/IP) or the operation

N/A

$reply["data"]["log"][]["action"]

String

Action

N/A

$reply["data"]["log"][]["time"]

String

Time of operation

N/A

$reply["data"]["log"][]["comments"]

String

Comments (NULL if not set)

N/A

Array

Type

Description

GET Parameter

$reply["data"]["log"]

Array

Array of logs

N/A

$reply["data"]["log"][]["flight_id"]

int

flight id of the flight concerned

N/A

$reply["data"]["log"][]["operating_user"]

String

Origin (Username/IP) or the operation

N/A

$reply["data"]["log"][]["action"]

String

Action

N/A

$reply["data"]["log"][]["time"]

String

Time of operation

N/A

$reply["data"]["log"][]["comments"]

String

Comments (NULL if not set)

N/A

Array

Type

Description

GET Parameter

$reply["data"]["log"]

Array

Array of logs. NULL if no data

N/A

$reply["data"]["log"][]["operating_user"]

String

Origin (Username/IP) or the operation

N/A

$reply["data"]["log"][]["action"]

String

Action

N/A

$reply["data"]["log"][]["time"]

String

Time of operation

N/A

$reply["data"]["log"][]["comments"]

String

Comments (NULL if not set)

N/A

$reply["data"]["flight_id"]

int

Flight id in DB

&flightid=<Int flightid>

$reply["data"]["is_archive"]

Boolean

"true" if the flight is archived
"false" if the flight is not yet archived

N/A

$reply["data"]["row"]

int

Row id in the current/archive flight list

N/A

$reply["data"]["offset"]

int

Offset of the flight list

N/A

$reply["data"]["callsign"]

String

Callsign

N/A

$reply["data"]["model"]

String

Aircraft model in human readable format. NULL if no such information in FGTracker

N/A

$reply["data"]["model_raw"]

String

Aircraft model in “--aircraft” format

N/A

$reply["data"]["start_time"]

String

Flight start time

N/A

$reply["data"]["start_time_utc"]

String

Flight start time in UTC

N/A

$reply["data"]["start_localtime"]

String

Flight start local time (only available if departure airport be identified)

N/A

$reply["data"]["start_time_raw"]

int

Flight start time in seconds (since Unix epoch)

N/A

$reply["data"]["start_location"]["icao"]

String

ICAO name of the departure airport. “----” if start location is not an airport

N/A

$reply["data"]["start_location"]["icao_name"]

String

Name of the departure airport. “Unknown” if start location is not an airport

N/A

$reply["data"]["start_location"]["country"]

String

Country of the departure airport. NULL if start location is not an airport or country cannot be identified

N/A

$reply["data"]["start_location"]["zone"]

String

(Time)zone of the departure airport. NULL if start location is not an airport or zone cannot be identified

N/A

$reply["data"]["start_location"]["start_time_local"]

String

Flight start local time (if departure airport be identified, otherwise missing)

N/A

$reply["data"]["end_time"]

String

Flight end time

N/A

$reply["data"]["end_time_utc"]

String

Flight end time in UTC

N/A

$reply["data"]["end_time_raw"]

int

Flight end time in seconds (since Unix epoch)

N/A

$reply["data"]["end_location"]["icao"]

String

ICAO name of the arrival airport. “----” if end location is not an airport

N/A

$reply["data"]["end_location"]["icao_name"]

String

Name of the arrival airport. “Unknown” if end location is not an airport

N/A

$reply["data"]["end_location"]["country"]

String

Country of the arrival airport. NULL if end location is not an airport or country cannot be identified

N/A

$reply["data"]["end_location"]["zone"]

String

(Time)zone of the arrival airport. NULL if end location is not an airport or zone cannot be identified

N/A

$reply["data"]["end_location"]["end_time_local"]

String

Flight end local time (if arrival airport be identified and the flight has ended, otherwise missing)

N/A

$reply["data"]["duration"]

String

Flight duration

N/A

$reply["data"]["duration_raw"]

int

Flight duration in seconds

N/A

$reply["data"]["wpts"]

String

Number of way points

N/A

$reply["data"]["wpt"]

Array

Array of way points

N/A

$reply["data"]["wpt"][]["time"]

String

Time of waypoint recorded

N/A

$reply["data"]["wpt"][]["time_raw"]

int

Time of waypoint recorded in seconds (since Unix epoch)

N/A

$reply["data"]["wpt"][]["lat"]

Float

Latitude of waypoint recorded

N/A

$reply["data"]["wpt"][]["lon"]

Float

Longitude of waypoint recorded

N/A

$reply["data"]["wpt"][]["alt"]

Float

Altitude of waypoint recorded

N/A

$reply["data"]["wpt"][]["hdg"]

Float

Heading of the plane. NULL if no data

N/A

$reply["data"]["previous_flight"]["flight_id"]

Int

Previous flight’s flight id in DB

N/A

$reply["data"]["previous_flight"]["model"]

String

Previous flight’s aircraft model in human readable format. NULL if no such information in FGTracker

N/A

$reply["data"]["previous_flight"]["model_raw"]

String

Previous flight’s aircraft model in “--aircraft” format

N/A

$reply["data"]["previous_flight"]["start_time"]

String

Previous flight’s start time in UTC

N/A

$reply["data"]["previous_flight"]["start_time_raw"]

int

Previous flight’s start time in seconds (since Unix epoch)

N/A

$reply["data"]["previous_flight"]["end_time"]

String

Previous flight’s end time in UTC

N/A

$reply["data"]["previous_flight"]["end_time_raw"]

int

Previous flight’s end time in seconds (since Unix epoch)

N/A

$reply["data"]["previous_flight"]["distance_difference"]

int

Distance between previous flight’s last waypoint and current flight’s first waypoint

N/A

$reply["data"]["previous_flight"]["mergeok"]

boolean

If the current flight can be merged to previous flight

N/A