FSAirlinesWiki - User contributions [en]

Blackbox

2013-06-27T06:37:52Z

Konny: /* Blackbox Packages */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/info-flighttracker FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|-
|[http://fsairlines.net/downloads/blackbox_new.zip Blackbox by Erwin Polreich ]
|Standard-Blackbox with some extra warnings, as for instance "switch on/off landing lights!" or "too fast!". A more detailed description of the extensions and the installation guidance is contained in the zip-file.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Comments===
With the blackbox.xml being a standard xml-file you can easily add comments between the single tags to improve the readability in bigger files. A comment starts with '''<nowiki></nowiki>'''. Here is a little exampe:
<pre>
<blackbox>

<startflight text="Flight started!" sound="boarding.wav" />

<event var="landinglights" value="1" method="equal" multiple="1" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance
*add a timer for events (e.g. event triggered after x secs/mins elapsed or event action occurs after a delay of x secs/mins)

Blackbox

2013-06-10T21:04:04Z

Konny: /* Blackbox Packages */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/info-flighttracker FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|-
|[http://fsairlines.net/downloads/blackbox_new.zip Blackbox by Erwin Polreich ]
|coming soon
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Comments===
With the blackbox.xml being a standard xml-file you can easily add comments between the single tags to improve the readability in bigger files. A comment starts with '''<nowiki></nowiki>'''. Here is a little exampe:
<pre>
<blackbox>

<startflight text="Flight started!" sound="boarding.wav" />

<event var="landinglights" value="1" method="equal" multiple="1" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance
*add a timer for events (e.g. event triggered after x secs/mins elapsed or event action occurs after a delay of x secs/mins)

Awards

2013-03-11T22:24:35Z

Konny:

[[Category:Features]]
On FSAirlines there are three different awards which are given to the best pilots of every month. Each pilot who is given such an award can find the badge on his [[profile]]. Additionally there are awards which every pilot can achieve after having flown a certain amount of miles/hours/...

==Pilot of the month awards==

===Most miles===
The pilot who has flown the most miles within a month (miles are adjusted by the simulation rate).

===Most hours===
The pilot who has been in cockpit for the longest time within a month (hours are adjuste by the simulation rate).

===Best rating===
The pilot who did at least 5 flights and has the best average [[flight rating]]. If more than one pilot have the same average flight rating, the one with the most flights is chosen.

==Standard awards==
The standard awards are given to any pilot achieving one of the goals listed below. For each category there are basic, 1-star, 2-star awards and finally one golden 3-star award.

===Airports===
The number of airports you have visited:
10, 50, 200 or 500 Airports.

===Real-Time===
The number of real-time flights in a row you have done:
10, 50, 250 or 1000 flights.

===100%===
The number of flights in a row with a 100% rating you have done:
10, 50, 200 or 500 flights.

===Passengers===
The number of passengers you have transported.
1000, 10000, 25000, 100000 or 500000 PAX.

===Miles===
The nautical miles you have done (divided by simulation-rate):
1000, 10000, 100000, 250000 or 1000000 nm.

===Hours===
The total hours have flown on FSAirlines (divided by simulation-rate):
50, 100, 250, 500, 1000 or 5000 hours.

XML-Interface

2013-01-12T00:34:42Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters in brackets are optional
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat, pax_economy, pax_business, pax_first
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number, pax_economy, pax_business, pax_first
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va, pax_economy, pax_business, pax_first
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat, vs, pax_economy, pax_business, pax_first, ticket_business, ticket_first, fuel_start, fuel_dep, fuel_takeoff, fuel_land, fuel_finish, ticket_factor, interface, simversion, os
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, route, limit_pax, limit_cargo
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

XML-Interface

2013-01-12T00:31:34Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters in brackets are optional
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat, pax_economy, pax_business, pax_first
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number, pax_economy, pax_business, pax_first
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat, vs, pax_economy, pax_business, pax_first, ticket_business, ticket_first, fuel_start, fuel_dep, fuel_takeoff, fuel_land, fuel_finish, ticket_factor, interface, simversion, os
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, route, limit_pax, limit_cargo
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

XML-Interface

2012-12-07T23:13:50Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters in brackets are optional
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat, pax_economy, pax_business, pax_first
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number, pax_economy, pax_business, pax_first
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, route, limit_pax, limit_cargo
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

XML-Interface

2012-12-02T18:31:27Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters in brackets are optional
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number, pax_economy, pax_business, pax_first
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, route, limit_pax, limit_cargo
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

XML-Interface

2012-12-02T18:25:36Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters in brackets are optional
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, route, limit_pax, limit_cargo
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

XML-Interface

2012-12-02T18:25:04Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, route, limit_pax, limit_cargo
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

XML-Interface

2012-09-12T13:56:31Z

Konny: /* Aircraft Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

If you need something to get started here's a small example PHP-script showing a list of your pilots' names. Just replace the va_id by your own.
<pre>
<?php
$objDOM = new DOMDocument();
$objDOM->load("http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7");

//uncomment to show raw xml-data
//echo $objDOM->saveXML();

$dataNodes = $objDOM->getElementsByTagName("data");
foreach( $dataNodes as $node )
{
$name = $node->getAttribute("name");
$surname = $node->getAttribute("surname");
echo "{$name} {$surname} ";
}
?>
</pre>

==Data==
The following section contains a detailed list of all the request-functions with their return values. Lately added options are marked green.

===Parameters===
All the request functions use parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path, pax_economy, pax_business, pax_first, config_name
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price (deprecated, will be removed in next release), reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, number
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, rank, flights, rating, hours, distance, pax, cargo_kg, picture
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|-
| getDistance
| va_id, icao_from, icao_to
| SUCCESS, NOT FOUND
| distance
|-
| getMetar
| va_id, icao
| SUCCESS, NOT FOUND
| metar
|}

===Notes===
<references />

===Requested additional functions===
The following list contains all the functions which were requested by users but aren't implemented yet.
*Create, edit and delete routes

Statistics

2011-11-16T18:39:39Z

Konny: /* An individual airline */

[[Category:Features]]
FSAirlines shows a lot of statistics about the airlines, pilots and aircraft types. The main statistics page is found in the '''Crew Centre''' under '''Database'''.

==Categories==
You can choose between different categories.

===All airlines===
Show statistics where all airlines are compared.

===All pilots===
Show statistics of individual pilots.

===All aircraft types===
Show statistics of the different aircraft types.

===An individual airline===
You can also show the statistics of the pilots in a certain airline. For an airline to show up in the list of choosable airlines it must have '''at least three active pilots''' within the last month.

==Data==
Choose which data to show.

===Passenger Miles===
The sum of each flight's passengers times miles (adjusted by simulation rate).

===Cargo Miles===
The sum of each flight's cargo times miles (adjusted by simulation rate).

===Payload Miles===
The sum of each flight's pax+cargo times miles (adjusted by simulation rate).

===Passengers===
The sum of passengers transported.

===Cargo===
The sum of cargo transported.

===Payload===
The sum of each flight's pax+cargo divided by 100.

===Miles===
The sum of the miles flown (adjusted by simulation rate).

===Hours===
The sum of each flight's hours (adjusted by simulation rate).

===Rating===
The sum of the [[Flight Rating|flight ratings]].

===Average Rating===
The average [[Flight Rating|flight rating]].

===Raw Miles===
The sum of the miles (not adjusted by simulation rate).

===Raw Passenger Miles===
The sum of each flight's pax times miles (not adjusted by simulation rate).

==Period==
Choose which period to show in the statistics: Current month, last month, cumulative or last 30/60/90 days.

[[Category:Database Features]]

Blackbox

2011-07-21T20:35:07Z

Konny: /* Blackbox Packages */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/info-flighttracker FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Comments===
With the blackbox.xml being a standard xml-file you can easily add comments between the single tags to improve the readability in bigger files. A comment starts with '''<nowiki></nowiki>'''. Here is a little exampe:
<pre>
<blackbox>

<startflight text="Flight started!" sound="boarding.wav" />

<event var="landinglights" value="1" method="equal" multiple="1" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance
*add a timer for events (e.g. event triggered after x secs/mins elapsed or event action occurs after a delay of x secs/mins)

Blackbox

2011-04-18T21:36:30Z

Konny: /* Comments */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Comments===
With the blackbox.xml being a standard xml-file you can easily add comments between the single tags to improve the readability in bigger files. A comment starts with '''<nowiki></nowiki>'''. Here is a little exampe:
<pre>
<blackbox>

<startflight text="Flight started!" sound="boarding.wav" />

<event var="landinglights" value="1" method="equal" multiple="1" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance
*add a timer for events (e.g. event triggered after x secs/mins elapsed or event action occurs after a delay of x secs/mins)

Blackbox

2011-04-18T21:32:05Z

Konny: /* Configuration */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Comments===
With the blackbox.xml being a standard xml-file you can easily add comments between the single tags to make maintaining bigger files more easy and improve the readability. A comment is starts with ''''''. Here is a little exampe:
<pre>
<blackbox>

<startflight text="Flight started!" sound="boarding.wav" />

<event var="landinglights" value="1" method="equal" multiple="1" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance
*add a timer for events (e.g. event triggered after x secs/mins elapsed or event action occurs after a delay of x secs/mins)

Blackbox

2011-04-18T21:12:30Z

Konny: /* Requested Additions */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance
*add a timer for events (e.g. event triggered after x secs/mins elapsed or event action occurs after a delay of x secs/mins)

Known Problems

2011-04-17T00:26:19Z

Konny:

Here is a list of known problems and their fixes. If you have one to add to this list, please mention it at the talk page.

==Client doesn't recognize Landing Lights status==
Some aircraft add-ons use a special way of setting the landing lights which can't be recognized by the Client. This is a problem caused by the developers of the add-on not using the standard SDK functions. If you experience this problem you can force the landing lights status as it is seen by the Client. The hotkey to toggle the landing lights is Ctrl-Shift-L. Having used this hotkey once in a flight the Client from then on will ignore the landing light readings from the flight simulator.

==[http://fsairlines.net/forum/viewtopic.php?f=60&t=5732 Tinmouse B737-200 Fueling Problem]==
If you are using the Tinmouse II Boeing 737-200 to fly on FSA you may have a problem refuelling. One of CBFS pilots has identified this problem and found a workaround. The chaps developing the Tinmouse II very kindly offered the facility to use the panel with the FFX/Vistaliner B737-200 and provided alternative .air and .cfg files for that aircraft. However, to identify which model was being used so that the panel sends the correct spoiler animations etc for the appropriate model, they added a dummy fuel tank to the Tinmouse aircraft.cfg

In the aircraft.cfg for the tinmouse look for the [fuel] as below :-

[fuel]

//Longitudinal (feet), Lateral (feet), Vertical (feet), Usable(gallons), Unusable (gallons)

fuel_type = 2
number_of_tank_selectors = 1

Center1 = 6.25, 0, -0.2, 2303.7, 0 // 15433 lbs max
LeftMain = 1.5, -9.6, -0.2, 1428.15, 0 // 9567 lbs max
RightMain = 1.5, 9.6, -0.2, 1428.15, 0
RightTip = 0.0, 0.0, 0.0, 1.0, 0 //DO NOT REMOVE presence of this tank used to identify Terry Gaff/Flight1 model
electric_pump=0

To make the fuel tank invisible to flight sim/FSA you need to rem out the line as below indicated in red.

[fuel]

//Longitudinal (feet), Lateral (feet), Vertical (feet), Usable(gallons), Unusable (gallons)

fuel_type = 2
number_of_tank_selectors = 1

Center1 = 6.25, 0, -0.2, 2303.7, 0 // 15433 lbs max
LeftMain = 1.5, -9.6, -0.2, 1428.15, 0 // 9567 lbs max
RightMain = 1.5, 9.6, -0.2, 1428.15, 0
//RightTip = 0.0, 0.0, 0.0, 1.0, 0 //DO NOT REMOVE presence of this tank used to identify Terry Gaff/Flight1 model
electric_pump=0

Once you have added the two forward slashes, save the file and exit. It says not to remove the tank but remming tthe tank it does not appear to have any adverse affect on the visuals.

==[http://fsairlines.net/forum/viewtopic.php?f=5&t=4675 AN-124 Fuel Consumption]==
The available Antonov AN-124 aircraft models do not compute there fuel usage properly and are often getting flagged by the system as possible fuel cheats. With the help of TJ Baughn of the 'Front Line Dirty Dozen' we worked out a solution for this. If you are using this aircraft please open the 'Aircraft.cfg' file in the folder containing this aircraft in your flight simulator installation and find this line:

fuel_flow_scalar=1.0

It may have a slightly different number after the '=' but change the 1.0 to 1.711, if its not at that value or higher already. If you do not do this you risk having your flights marked as cheats, the reputation of your airline ruined and probably forced into bankruptcy.

==[http://fsairlines.net/forum/viewtopic.php?f=86&t=5558 Windows 2000 and FS Airlines Compatibility]==
For everyone who is using Windows 2000 and can't run the Client, the reason for this are some functions needed for SimConnect which are only installed on Windows XP / Vista systems.
For these users, there's a special build without SimConnect. You can get it here:
http://fsairlines.net/downloads/FSAirlines_v120noSC.zip

==[http://fsairlines.net/forum/viewtopic.php?f=60&t=5921 Auto Fueling in FS9]==
Hi,

Whilst digging around I took a look at the advanced options of FSUIPC and came across this :-

''StopAutoFuel: Set this to ‗Yes‘ on FS2002/4 to stop automatic re-fuelling at scenery fuel boxes. With this selected you can only increase fuel via the FS menu or by using a program or gauge which does it via FSUIPC‘s offsets.''

It only appears to work with a registered copy as the entry is already in the configuration settings with a default 'no'. When removing the registration details and restarting, the configuration settings file is somewhat smaller and the relevant entry is missing. Adding the missing entry and saving to a non-registered configuration settings file doesn't stop auto refuelling.

So, for those of you with a registered copy and want to close one door that might otherwise give you a flight marked cheat, look for the following entry in the FSUIPC configuration settings and make sure it reads 'yes' :-

StopAutoFuel=Yes

==[http://fsairlines.net/forum/viewtopic.php?f=86&t=6153 Fixes to Common Problems]==
The topic above lists fixes to common problems that arise. Rather than list them all out here, they will remain only listed in that topic.

Blackbox

2011-04-16T23:28:48Z

Konny: /* Requested Additions */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Actual route flown distance

Blackbox

2011-04-16T23:02:17Z

Konny: /* Event variables */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only at the beginning of the flight and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T23:00:50Z

Konny: /* Tags */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!Tag
!Attributes
!Description
|-
|event
|see [[#Event attributes|Event attributes]] below
|See [[#Event criteria|Event criteria]] and [[#Event actions|Event actions]]
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|See [[#Combination tag|Combination tag]]
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|See [[#Startflight tag|Startflight tag]]
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T23:00:26Z

Konny: /* Combination Tag */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T23:00:21Z

Konny: /* Startflight Tag */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T22:57:09Z

Konny: /* Event attributes */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight Tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!Attribute
!Possible values
!Standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T22:56:38Z

Konny: /* Event attributes */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight Tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see [[#Event variables|Event variables]] table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T22:53:04Z

Konny: /* Overview */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight Tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains three tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T22:52:34Z

Konny: /* Startflight Tag */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight Tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T22:52:05Z

Konny: /* Configuration */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Startflight Tag===
The startflight tag is activated immediately when you start the flight with the Client. You can add a sound and a text attribute to the startflight tag, all other attributes are just ignored.
<pre>
<blackbox>
<startflight text="Flight started!" sound="boarding.wav" />
<blackbox>
</pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T22:46:27Z

Konny: /* Combination Tag */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. This means that the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:56:26Z

Konny: /* Combination Tag */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. So, the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav" multiple="0">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:55:37Z

Konny: /* Combination Tag */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. So, the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav">
<event var="altitudestd" value="10000" method="greater" multiple="1" />
<event var="landinglights" value="1" method="equal" multiple="1" />
</combination>
<blackbox>
</pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:54:47Z

Konny: /* Configuration */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Combination Tag===
The combination tag allows to check if multiple events are active at the same time. In other words you can check for a combination of events. The following example shows a combination of two events, the first one being activated when the aircraft climbs above 10000ft and the second one being activated when the landing lights are on. So, the combination event will be activated when the landing lights are on above 10000ft.
<pre>
<blackbox>
<combination text="Landing Lights on above FL100" sound="lightsFL100.wav">
<event var="landinglights" value="1" method="equal" multiple="1" />
<event var="altitudestd" value="10000" method="greater" multiple="1" />
</combination>
<blackbox>
</pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:44:14Z

Konny: /* Tags */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see [[#Event attributes|Event attributes]] below
|-
|combination
|'''text''', '''sound''' and '''multiple''' from [[#Event attributes|Event attributes]] table
|-
|startflight
|'''text''' and '''sound''' from [[#Event attributes|Event attributes]] table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:39:16Z

Konny: /* Event variables */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see "Event attributes" below
|-
|combination
|text, sound and multiple from "Event attributes" table
|-
|startflight
|text and sound from "Event attributes" table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
| width=90 | 0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Block) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and ''method="equal"''.
|-
|aircrafttype
|XXXX
|The booked aircraft type. Use 4-letter ICAO designator (e.g. B744) and ''method="equal"''.
|-
|destination
|XXXX
|The destination of the booked route. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''.
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Use 4-letter ICAO designator (e.g. KJFK) and ''method="equal"''. ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:30:39Z

Konny: /* Event variables */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see "Event attributes" below
|-
|combination
|text, sound and multiple from "Event attributes" table
|-
|startflight
|text and sound from "Event attributes" table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|-
|flightstate
|0 (Boarding) 1 (Taxi) 2 (Take Off) 3 (Landed) 4 (On Blcok) 5 (Climb) 6 (Cruise) 7 (Descent) 8 (Crashed)
|The current flightstate. Use the correct number and method="equal".
|-
|aircrafttype
|XXXX
|The booked aircraft type. Enter 4-letter ICAO designator (e.g. B744).
|-
|destination
|XXXX
|The destination of the booked route. Enter 4-letter ICAO designator (e.g. KJFK)
|-
|closestairport
|XXXX
|The airport closest to the current aircraft position. Enter 4-letter Icao desigantor (e.g. KJFK). ''Updates only when flight is started and after touch-down.''
|-
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:21:23Z

Konny: /* Event attributes */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see "Event attributes" below
|-
|combination
|text, sound and multiple from "Event attributes" table
|-
|startflight
|text and sound from "Event attributes" table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate aircrafttype destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:20:25Z

Konny: /* Event attributes */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see "Event attributes" below
|-
|combination
|text, sound and multiple from "Event attributes" table
|-
|startflight
|text and sound from "Event attributes" table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs flightstate destination closestairport 
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Blackbox

2011-04-16T21:15:48Z

Konny: /* Overview */

[[Category:Features]]
The Blackbox is a Client module running during flight and recording certain events which can be defined in a xml file. There are two output possibilities:
*Text output to the flight log. The text is uploaded together with the flight report and can be viewed on the website after the flight.
*Immediate sound output. User-defined wav-files can be played immediately when an event occurs.
With these two options it's possible to record predefined flight states for a more detailed flight analysis and to enhance the flight environment with sounds. You could for example play a flight attendant announcement sound when you reach a certain altitude or some Co-Pilot sounds when the it's time to turn off the landing lights... there are endless possibilites.
The Client comes with a basic blackbox file to get you started but you can easily adapt it to your own needs. If there's something you're missing or if you need help please don't hesitate to ask in the forums.

==Blackbox Packages==
If you created your own blackbox.xml and want to share it with others, please add a link here. In case you don't have webspace on your own you can always contact the devs and they will upload it to the fsairlines server, thanks :).

{| class="wikitable"
!Link
!Description
|-
|[http://fsairlines.net/client-page FSAirlines Client]
|The standard blackbox package coming with the Client. Includes some gear, flaps and landing light info plus an applause sound when the aircraft touches ground.
|}

==Configuration==
The configuration of the Blackbox is saved in the blackbox.xml file which resides in the [[Client data folder]]. This xml file can be freely edited with any text-editor using the following commands.

===General structure===
The blackbox.xml basically only consists of a couple of event tags encapsulated by the blackbox tag. Each of these event tags contains attributes describing the event to record. The following example is the standard blackbox.xml coming with every Client release:
<pre><blackbox>
<event var="landinglights" value="1" method="equal" multiple="1" text="Landing Lights on" />
<event var="landinglights" value="0" method="equal" multiple="1" text="Landing Lights off" />
<event var="gear" value="1" method="equal" multiple="1" text="Gear down" />
<event var="gear" value="0" method="equal" multiple="1" text="Gear up" />
<event var="flaps" value="1" method="equal" multiple="1" text="Flaps 100%" />
<event var="flaps" value="0.5" method="equal" multiple="1" text="Flaps 50%" />
<event var="flaps" value="0" method="equal" multiple="1" text="Flaps retracted" />
<event var="vs" value="-200" method="greater" multiple="0" flightstate="landed" sound="snd_applause.wav" />
</blackbox>
</pre>

===Event criteria===
As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:
<pre><event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" /></pre>
First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The following attribute is value. This is the reference value for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated the first time the landing lights are turned on.
The flightstate attribute restricts the event activation to a single flightstate. Hence if you only want the event to be activated during take off you could set this to takeoff.

===Event actions===
The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, the text will be shown in the log on the website.

If you add a sound attribute, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. If you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called FL100.wav when the airplane climbs above FL100. First you create a folder for all your personal sound files inside your Client sound directory. This not mandatory but we recommend to do it this way so the different sound files don't get mixed up. We call it my_va. The Client sound folder looks like this then:
<pre>sounds/en/*.wav
sounds/my_va/FL100.wav</pre>
In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time. The final event tag looks like this:
<pre><event var="altitudestd" value="10000" method="greater" multiple="0" sound="my_va/FL100.wav" /></pre>

===Overview===
This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

====Tags====
{| class="wikitable"
!tag
!attributes
|-
|event
|see "Event attributes" below
|-
|combination
|text, sound and multiple from "Event attributes" table
|-
|startflight
|text and sound from "Event attributes" table
|}

====Event attributes====
{| class="wikitable"
!attribute
!possible values
!standard value
|-
|var
|altitudeagl altitudestd flaps gear ias landinglights vs
|ias
|-
|value
|depends on variable (see table below)
|0
|-
|method
|less equal greater
|equal
|-
|multiple
|0 1
|0
|-
|flightstate
|boarding taxi takeoff climb cruise descent landed
|undefined
|-
|text
|any text up to 255 characters
|undefined
|-
|sound
|relative path from Client sound directory to .wav file
|undefined
|}

====Event variables====
{| class="wikitable"
!Variable
!Values
!Description
|-
|landinglights
|0 or 1
|Status of the landing lights. 1 = on, 0 = off.
|-
|gear
|0 or 1
|Status of the gear. 1 = down, 0 = up.
|-
|flaps
|0.0 - 1.0
|Status of the flaps. 0 = fully retracted, 1 = fully extended.
|-
|ias
|0 - 9999
|Indicated airspeed (knots).
|-
|groundspeed
|0 - 9999
|Ground speed (knots).
|-
|vs
| -9999 - 9999
|Vertical speed (fpm).
|-
|altitudestd
|0 - 999999
|Altitude above 1013.25hP (Standard atmosphere) in feet.
|-
|altitudeagl
|0 - 999999
|Altitude above ground level (feet).
|}
Need more variables? Don't hesitate to ask in the forums!

==Requested Additions==
More features which have been requested:
*Combination of different variables (e.g. trigger if certain speed and altitude are reached)
*Trigger when flight is started
*Trigger by flightstate only
*Actual route flown distance
*Trigger by airport/location (after landing)
*Trigger by aircraft type
*Trigger by destination

Main Page

2010-11-20T20:29:02Z

Konny:

[[Image:Mainheaderlogo.png|center]]
 
__NOEDITSECTION__
{| width="100%" border="0" cellspacing="30" cellpadding="5"
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''[[Getting started|Getting Started]]''' 
[[Register_-_Create_a_new_Pilot_account|Register as a Pilot]] ·
[[Create your Virtual Airline|Create a Virtual Airline]] ·
[[Join an existing Virtual Airline|Join a Virtual Airline]] ·
[[Build_up_your_fleet_and_assign_type_ratings|Build up fleet and assign type ratings]] · [[Define your routes]] · [[The First Flight]]
| valign="topright" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''General Information''' 
[[:Category:Tutorials|Tutorials]] · [[:Category:Features|Features]] ·
[[Knownproblems|Known Problems]] · [[VA Integration Kit]] · [[Release|Release notes]] ([[Release/latest|latest]])
|-
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''[[:Category:Pilot Features|Pilot features]]''' 
[[:Profile]] · [[:Messages]] · [[:Hangar]] · [[:Belongings]] · [[:Logbook]] · [[:Book Flight]]
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''[[:Category:Terminology|The Three A's]]''' 
[[:Category:Airline Pages|Airlines]] · [[:Category:Airplane Pages|Airplanes]] · [[:Category:Alliance Pages|Alliances]]
|-
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''[[:Category:Virtual Airline Features|Virtual Airline features]]''' 
[[:Overview]] · [[:Fleets]] · [[:Flightplan]] · [[:Partnerships]] · [[:Finances]] · [[:Blackboard]] · [[:Advertisements]]
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''[[:Category:Community|Community]]''' 
[http://www.fsairlines.net/forum Forums] · [http://www.fsairlines.net Main Website] ·
[http://fsairlines.net/forum/viewtopic.php?f=61&t=3820 Screenshots]
|-
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" | '''[[:Category:Database Features|Database features]]''' 
[[:Statistics]] · [[:Aircraft types]] · [[:Airports]] · [[:Languages]] · [[:Admin login]]
| valign="top" width="50%" style="font-family: Verdana, Arial, Helvetica, sans-serif; font-size: small;" |'''[[:FS_Airlines_Client|The Client]]''' 
[[:Client Options]] · [[:Client_Flight_Information|Flight Information]] ·
[[Fly!]] · [[Client Plugin Beta]] · [[Debug File]] · [[Blackbox]]
|-
| colspan="4" style="font-family: Verdana, Arial, Helvetica, sans-serif; border-top: 1px solid #AAAAAA;" |[[Image:Bit.gif|center|3px]]<center>'''[[FSAirlinesWiki:About|About The FSA Wiki]] · [[Help:Contents|Help]] · [[Special:Categories|Categories]] · [[Special:Allpages|All Pages]] · [[Special:Newpages|New Pages ]]'''</center>[[Image:Bit.gif|center|3px]]
|}

<table border="0" valign="top">
<tr>
<td width="55%" valign="top" style="padding-right: 20;">
<div class="toc" valign="top" style="border:2px solid #205080; color: #000; background-color: #E4F0F9; padding: 10px; padding-left: 16px; padding-right: 16px;">
{{Featured article}}
</div>



__NOTOC__

Official FSAirlines Integration Pack

2010-11-20T20:26:03Z

Konny: /* For developers */

[[Category:Website Integration Packs]]
{{Infobox integration pack
|Version=1.0
|Date=September 9th, 2010
|Developers=[[User:Konny|Konny]]
Joe
|Svn path=/trunk
}}

==How to use==
The Integration Pack has been designed for easy integration into any website. There are no special requirements to the webserver. The easiest way to get the data into your own website is by using the [http://www.w3schools.com/TAGS/tag_iframe.asp <iframe>] HTML-Tag. Here's an example HTML-code:
<pre><iframe width="600" height="500" src="http://remote.fsairlines.net/v1/roster.php?rvi=368&title=off">
Your browser does not support iframes.
</iframe></pre>
The ''src="..."'' part determines which data is shown. Just copy the required url from the list of [[#Pages|pages]]. There are several [[#Parameters|parameters]] which can be appended to the url. These can be used to change for example the language or the color of the included page. The ''rvi=xxxx'' parameter is mandatory and has to be changed to the [[Virtual Airline Overview|ID]] of your own Virtual Airline. All other parameters have to be added with a leading '&' just like the '&title=off' in the example.

==For developers==
The FSAirlines Integration Pack is Open-Source, so everybody with a [[VA Integration Kit#Developer Account|developers account]] can enhance and improve the scripts. All the files are located in the trunk folder of the FSAirlines Subversion repository. We will review all the changes and from time to time publish the current revision under a new version number. You're welcome to implement anything you think is useful, but please stick to the following rules:
*Please don't do massive layout changes. If you want a completely different look please create a new branch, maybe you can convince us and we will merge it with the Official Integration Pack.
*Please don't remove any functionality. You're free to extend the scripts, but if you feel like there should be a page with less information, please create a new one.
*Don't use function calls to the [[XML-Interface]] in loops. If you need a different data set, please ask the developers to add a function for that to the [[XML-Interface]].
*Always keep record of your changes on this wiki page.

==Parameters==
Here is a list of all the parameters which are currently supported.
{| class="wikitable"
| '''rvi=XXX'''
| '''Virtual Airline ID number (mandatory)'''
|-
| lng=XX
| Language translation (Coming Soon)
|-
| title=off
| Hide the title of the pages
|-
| hub=XXXX
| Four letter ICAO code, used by Timetable to show flights to and from the selected airport
|-
| cli=XXXXXX
| Link Color, Six letter HTML Color code
|-
| clv=XXXXXX
| Visited Link Color, Six letter HTML Color code
|-
| clh=XXXXXX
| Hover Link Color, Six letter HTML Color code
|-
| textcol=XXXXXX
| Text Color, Six letter HTML Color code
|-
| tblcol=XXXXXX
| Table Heading Background Color, Six letter HTML Color code
|-
| tbltextcol=XXXXXX
| Table Heading Text Color, Six letter HTML Color code
|-
| row1=XXXXXX
| Data Row 1 Color, Six letter HTML Color code
|-
| row2=XXXXXX
| Data Row 2 Color, Six letter HTML Color code
|}

==Pages==
The following table shows all the pages which you can include in your own VA website.
{| class="wikitable"
| Roster
| http://remote.fsairlines.net/v1/roster.php?rvi=368
|-
| Roster ( Alternate )
| http://remote.fsairlines.net/v1/roster_2.php?rvi=368
|-
| Fleet
| http://remote.fsairlines.net/v1/fleet.php?rvi=368
|-
| Fleet ( Alternate )
| http://remote.fsairlines.net/v1/fleet_2.php?rvi=368
|-
| Timetable
| http://remote.fsairlines.net/v1/timetable.php?rvi=368
|-
| Timetable ( Alternate )
| http://remote.fsairlines.net/v1/timetable_2.php?rvi=368
|-
| Flight Reports ( Pireps )
| http://remote.fsairlines.net/v1/pireps.php?rvi=368
|-
| Financial Report
| http://remote.fsairlines.net/v1/finance.php?rvi=368
|-
| Reliability Report
| http://remote.fsairlines.net/v1/reliability.php?rvi=368
|-
| Pilot Stats
| http://remote.fsairlines.net/v1/pilotstats.php?rvi=368
|-
| Monthly Pilot Stats
| http://remote.fsairlines.net/v1/mpilotstats.php?rvi=368
|-
| Fleet Stats
| http://remote.fsairlines.net/v1/fleetstats.php?rvi=368
|-
| Monthly Fleet Stats
| http://remote.fsairlines.net/v1/mfleetstats.php?rvi=368
|-
| Country Stats
| http://remote.fsairlines.net/v1/countrystats.php?rvi=368
|-
| Dispatch Office
| http://remote.fsairlines.net/v1/dispatch.php?rvi=368
|-
| Pilot Registration & Application (*)
| http://remote.fsairlines.net/v1/application.php?rvi=368
|-
| Infobox
| http://remote.fsairlines.net/v1/infobox.php?rvi=368
|-
| Infobox ( Alternate )
| http://remote.fsairlines.net/v1/infobox2.php?rvi=368
|-
| Booked Flights
| http://remote.fsairlines.net/v1/flights_booked.php?rvi=368
|-
| Active Flights
| http://remote.fsairlines.net/v1/flights_active.php?rvi=368
|-
| Active Flights ( Alternate )
| http://remote.fsairlines.net/v1/flights_active2.php?rvi=368
|-
| Last Flights
| http://remote.fsairlines.net/v1/lastflights.php?rvi=368
|}

==Demos==
Here can have a look at how the pages of the Integration Pack look like.
===Basic VA data===

<div class="NavFrame">
<div class="NavHead">Roster</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/roster.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Roster (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/roster_2.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Fleet</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/fleet.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Fleet (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/fleet_2.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Timetable</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/timetable.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Timetable (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/timetable_2.php?rvi=7&title=off</anyweb>
</div>
</div>

===Reports===

<div class="NavFrame">
<div class="NavHead">Flight Reports (PIREPs)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/pireps.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Financial Report</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/finance.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Reliability Report</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/reliability.php?rvi=7&title=off</anyweb>
</div>
</div>

===Statistics===

<div class="NavFrame">
<div class="NavHead">Pilot Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/pilotstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Monthly Pilot Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/mpilotstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Fleet Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/fleetstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Monthly Fleet Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/mfleetstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Country Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/countrystats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Infobox</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/infobox.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Infobo (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/infobox2.php?rvi=7&title=off</anyweb>
</div>
</div>

===Interactive===

<div class="NavFrame">
<div class="NavHead">Dispatch Office</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/dispatch.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Pilot Registration & Application</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/application.php?rvi=7&title=off</anyweb>
</div>
</div>

===Flights===

<div class="NavFrame">
<div class="NavHead">Booked Flights</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/flights_booked.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Active Flights</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/flights_active.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Active Flights (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/flights_active2.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Last Flights</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/lastflights.php?rvi=7&title=off</anyweb>
</div>
</div>

MediaWiki:Sidebar

2010-11-20T20:24:13Z

Konny:

Official FSAirlines Integration Pack

2010-11-20T20:21:05Z

Konny:

[[Category:Website Integration Packs]]
{{Infobox integration pack
|Version=1.0
|Date=September 9th, 2010
|Developers=[[User:Konny|Konny]]
Joe
|Svn path=/trunk
}}

==How to use==
The Integration Pack has been designed for easy integration into any website. There are no special requirements to the webserver. The easiest way to get the data into your own website is by using the [http://www.w3schools.com/TAGS/tag_iframe.asp <iframe>] HTML-Tag. Here's an example HTML-code:
<pre><iframe width="600" height="500" src="http://remote.fsairlines.net/v1/roster.php?rvi=368&title=off">
Your browser does not support iframes.
</iframe></pre>
The ''src="..."'' part determines which data is shown. Just copy the required url from the list of [[#Pages|pages]]. There are several [[#Parameters|parameters]] which can be appended to the url. These can be used to change for example the language or the color of the included page. The ''rvi=xxxx'' parameter is mandatory and has to be changed to the [[Virtual Airline Overview|ID]] of your own Virtual Airline. All other parameters have to be added with a leading '&' just like the '&title=off' in the example.

==For developers==
The FSAirlines Integration Pack is Open-Source, so everybody with a [[VA Integration Kit#Developer Account|developers account]] can enhance and improve the scripts. All the files are located in the trunk folder of the FSAirlines Subversion repository. We will review all the changes and from time to time publish the current revision under a new version number. You're welcome to implement anything you think is useful, but please stick to the following rules:
*Please don't do massive layout changes. If you want a completely different look please create a new branch, maybe you can convince us and we will merge it with the Official Integration Pack.
*Please don't remove any functionality. You're free to extend the scripts, but if you feel like there should be a page with less information, please create a new one.
*Don't use function calls to the [[XML-Interface]] in loops. If you need a different data set, please ask the developers to add a function for that to the [[XML-Interface]].

==Parameters==
Here is a list of all the parameters which are currently supported.
{| class="wikitable"
| '''rvi=XXX'''
| '''Virtual Airline ID number (mandatory)'''
|-
| lng=XX
| Language translation (Coming Soon)
|-
| title=off
| Hide the title of the pages
|-
| hub=XXXX
| Four letter ICAO code, used by Timetable to show flights to and from the selected airport
|-
| cli=XXXXXX
| Link Color, Six letter HTML Color code
|-
| clv=XXXXXX
| Visited Link Color, Six letter HTML Color code
|-
| clh=XXXXXX
| Hover Link Color, Six letter HTML Color code
|-
| textcol=XXXXXX
| Text Color, Six letter HTML Color code
|-
| tblcol=XXXXXX
| Table Heading Background Color, Six letter HTML Color code
|-
| tbltextcol=XXXXXX
| Table Heading Text Color, Six letter HTML Color code
|-
| row1=XXXXXX
| Data Row 1 Color, Six letter HTML Color code
|-
| row2=XXXXXX
| Data Row 2 Color, Six letter HTML Color code
|}

==Pages==
The following table shows all the pages which you can include in your own VA website.
{| class="wikitable"
| Roster
| http://remote.fsairlines.net/v1/roster.php?rvi=368
|-
| Roster ( Alternate )
| http://remote.fsairlines.net/v1/roster_2.php?rvi=368
|-
| Fleet
| http://remote.fsairlines.net/v1/fleet.php?rvi=368
|-
| Fleet ( Alternate )
| http://remote.fsairlines.net/v1/fleet_2.php?rvi=368
|-
| Timetable
| http://remote.fsairlines.net/v1/timetable.php?rvi=368
|-
| Timetable ( Alternate )
| http://remote.fsairlines.net/v1/timetable_2.php?rvi=368
|-
| Flight Reports ( Pireps )
| http://remote.fsairlines.net/v1/pireps.php?rvi=368
|-
| Financial Report
| http://remote.fsairlines.net/v1/finance.php?rvi=368
|-
| Reliability Report
| http://remote.fsairlines.net/v1/reliability.php?rvi=368
|-
| Pilot Stats
| http://remote.fsairlines.net/v1/pilotstats.php?rvi=368
|-
| Monthly Pilot Stats
| http://remote.fsairlines.net/v1/mpilotstats.php?rvi=368
|-
| Fleet Stats
| http://remote.fsairlines.net/v1/fleetstats.php?rvi=368
|-
| Monthly Fleet Stats
| http://remote.fsairlines.net/v1/mfleetstats.php?rvi=368
|-
| Country Stats
| http://remote.fsairlines.net/v1/countrystats.php?rvi=368
|-
| Dispatch Office
| http://remote.fsairlines.net/v1/dispatch.php?rvi=368
|-
| Pilot Registration & Application (*)
| http://remote.fsairlines.net/v1/application.php?rvi=368
|-
| Infobox
| http://remote.fsairlines.net/v1/infobox.php?rvi=368
|-
| Infobox ( Alternate )
| http://remote.fsairlines.net/v1/infobox2.php?rvi=368
|-
| Booked Flights
| http://remote.fsairlines.net/v1/flights_booked.php?rvi=368
|-
| Active Flights
| http://remote.fsairlines.net/v1/flights_active.php?rvi=368
|-
| Active Flights ( Alternate )
| http://remote.fsairlines.net/v1/flights_active2.php?rvi=368
|-
| Last Flights
| http://remote.fsairlines.net/v1/lastflights.php?rvi=368
|}

==Demos==
Here can have a look at how the pages of the Integration Pack look like.
===Basic VA data===

<div class="NavFrame">
<div class="NavHead">Roster</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/roster.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Roster (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/roster_2.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Fleet</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/fleet.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Fleet (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/fleet_2.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Timetable</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/timetable.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Timetable (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/timetable_2.php?rvi=7&title=off</anyweb>
</div>
</div>

===Reports===

<div class="NavFrame">
<div class="NavHead">Flight Reports (PIREPs)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/pireps.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Financial Report</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/finance.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Reliability Report</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/reliability.php?rvi=7&title=off</anyweb>
</div>
</div>

===Statistics===

<div class="NavFrame">
<div class="NavHead">Pilot Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/pilotstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Monthly Pilot Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/mpilotstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Fleet Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/fleetstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Monthly Fleet Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/mfleetstats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Country Stats</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/countrystats.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Infobox</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/infobox.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Infobo (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/infobox2.php?rvi=7&title=off</anyweb>
</div>
</div>

===Interactive===

<div class="NavFrame">
<div class="NavHead">Dispatch Office</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/dispatch.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Pilot Registration & Application</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/application.php?rvi=7&title=off</anyweb>
</div>
</div>

===Flights===

<div class="NavFrame">
<div class="NavHead">Booked Flights</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/flights_booked.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Active Flights</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/flights_active.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Active Flights (Alternate)</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/flights_active2.php?rvi=7&title=off</anyweb>
</div>
</div>

<div class="NavFrame">
<div class="NavHead">Last Flights</div>
<div class="NavContent">
<anyweb>http://remote.fsairlines.net/v1/lastflights.php?rvi=7&title=off</anyweb>
</div>
</div>

XML-Interface

2010-11-20T20:11:43Z

Konny: /* Access Restriction */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially.
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

XML-Interface

2010-11-20T18:01:16Z

Konny:

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

XML-Interface

2010-11-20T17:59:55Z

Konny: /* Access Restriction */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered in our database. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

XML-Interface

2010-11-20T17:58:41Z

Konny:

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Access Restriction==
In order to be able to receive data from the XML-Interface the domain of your VA's website must be registered on FSAirlines.net. There are different access levels available:
*Read only access for your VA
*Read and write access (except account creation) for your VA. This access level will be given to you initially
*Read and write access for your VA. This access level will be given to your VA if you show our privacy policy on your registration page.
To request one of these access levels, please contact the admins using a support ticket and don't forget to add the domain of your website.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

Blackbox

2010-11-20T17:29:40Z

Konny:

Blackbox

2010-11-14T12:35:36Z

Konny:

XML-Interface

2010-11-12T13:15:11Z

Konny: /* Flight Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}

===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

XML-Interface

2010-11-12T13:14:53Z

Konny: /* Aircraft Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params" />
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}
===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

XML-Interface

2010-11-12T13:14:29Z

Konny: /* Airport Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params" />
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}
===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />

XML-Interface

2010-11-12T13:14:24Z

Konny: /* Financial Data */

The XML-Interface is the core of the [[VA Integration Kit]]. It has been designed to give VA Administrators with the knowledge of dynamic web techniques the possibility to create their own layout and perfectly integrate the information into their own website using XML data from FSAirlines.

==Basic Usage==
The data can be received using HTTP calls to the interface script and add the desired function to the parameters. Here is an example request:
<pre>http://www.fsairlines.net/va_interface.php5?function=getPilotList&va_id=7</pre>
As you can see there is the interface script ''va_interface.php5'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

The result of the request will be given in xml format with the base-tag being ''<fsa_output>''. This tag has the attributes ''version'' and ''success'' which show the version number of the interface and if the request succeeded or not. In case of a failure the ''success''-attribute shows the error message. The following example shows the return text of the above function:
<pre><fsa_output version="1.0" success="SUCCESS">
<data id="1" name="Konrad" surname="Pustka" va_user="SNA101" location="EDDM" lastactive="1287330550" budget="198144" />
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" />
</fsa_output></pre>
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information.
To use this data in your own webpage you need some knowledge in dynamic web-programming, for example PHP. We can't give you a complete introduction into PHP, but you can always have a look at the [[Official FSAirlines Integration Pack]] and see how we readout the data there.

==Data==
The following section contains a detailed list of all the request-functions with their return values.

===Parameters===
All the request functions need parameters which need to be appended. The following table shows all the parameters and their meaning.
{| class="wikitable"
! Parameter
! Meaning
|-
| ac_id
| ID of the aircraft. Is part of the data received from other functions (e.g. getAircraftList).
|-
| accept_pp
| Must be set '1' if Privacy Policy is accepted.
|-
| acdb_id
| ID of the aircraft type. Is part of the data received from other functions (e.g. getAircraftList).
|-
| airport
| Starting airport. Where the user should be placed first.
|-
| arr
| ICAO code of the arrival airport.
|-
| count
| Number past flights which should be displayed.
|-
| country
| Name of the country.
|-
| days
| Number of past days from now which should be displayed.
|-
| dep
| ICAO code of the departure airport.
|-
| email
| E-Mail of the user.
|-
| fleet_id
| ID of the fleet. Is part of the data received from other functions.
|-
| from_ts
| UNIX timestamp of the date where the listing should start.
|-
| givenname
| Given name of the user.
|-
| icao
| ICAO code of the airport.
|-
| passwd
| Password of the pilot (MD5 encrypted).
|-
| password
| Password of the user.
|-
| pilot_id
| ID of the pilot. Is part of the data received from other functions.
|-
| report_id
| ID of the report. Is part of the data received from other functions.
|-
| surname
| Surname of the user.
|-
| to_ts
| UNIX timestamp of the date where the listing should end.
|-
| user
| Username of the pilot.
|-
| username
| Requested username.
|-
| va_id
| ID of the [[Virtual Airline]]. Is displayed on the [[Overview]] page.
|}

===Aircraft Data===
{| class="wikitable"
! Function
! Parameters<ref name="params">Parameters in brackets are optional</ref>
! Return Codes
! Data
|-
| getAircraftData
| va_id, ac_id
| SUCCESS, NOT FOUND
| id, va_id, acdb_id, location, va_id, user_id, lease_id, fleet_id, status, value, registration, fuel, state, ac_name, stateeng1, stateeng2, stateeng3, stateeng4, stategear, statehull, img_path
|-
| getAircraftDBData
| va_id, acdb_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, passengers, price, fuel, dow, mtow, speed, engines, cargo, mzfw, market_only, range
|-
| getAircraftDBList
| va_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao
|-
| getAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getAircraftStats
| va_id, ac_id
| SUCCESS, NOT FOUND
| flights, hours, distance
|-
| getFleetAircraftList
| va_id, fleet_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registration, state, ac_name, status, fleet_id, fuel
|-
| getFleetList
| va_id
| SUCCESS, NOT FOUND
| id, name
|-
| getFleetStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getLeasedAircraftList
| va_id
| SUCCESS, NOT FOUND
| id, acdb_id, icao, value, location, registraion, state, ac_name, status, fleet_id, fuel, va_id, name, expire
|-
| getPeriodFleetStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, hours, distance, last, fuel_used, profit, cargo_kg, pax
|}

===Airport Data===
{| class="wikitable"
! Function
! Parameters<ref name="params" />
! Return Codes
! Data
|-
| getAirportData
| va_id, icao
| SUCCESS, NOT FOUND
| id, name, iata, icao, city, country, la_g, la_p, la_s, la_d, lat, lo_g, lo_p, lo_s, lo_d, lon, altitude, length, fuel, size
|-
| getAirportList
| va_id
| SUCCESS, NOT FOUND
| icao, name, city, country, fuel, lat, lon
|}

===Airline Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getAirlineData
| va_id, id (=va_id)
| SUCCESS, NOT FOUND
| id, name, base, code, budget, homepage, logo_l, logo_s, price, reputation, pilotcharge, multiplier, mission
|-
| getAirlineStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, pax, cargo_kg
|-
| getCountryStats
| va_id, country
| SUCCESS, NOT FOUND
| va_name, id, flights, rating hours, profit, distance, last, fuel_used, pax, cargo_kg
|-
| getRankList
| va_id
| SUCCESS, NOT FOUND
| id, name, short, settings, pilots, aircrafts, fleet, flights, partnerships, advertisements, fleet_id
|}

===Financial Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getLast10Transactions
| va_id
| SUCCESS, NOT FOUND
| ts, value, reason
|-
| getNegTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|-
| getPosTransactionSums
| va_id
| SUCCESS, NOT FOUND
| value, reason
|}

===Flight Data===
{| class="wikitable"
! Function
! Parameters<ref name="params" />
! Return Codes
! Data
|-
| getActiveFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp
|-
| getBookedFlights
| va_id
| SUCCESS, NOT FOUND
| departure, arrival, passengers, cargo, user_id, ac_id
|-
| getFlightReports
| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
| SUCCESS, NOT FOUND
| id, dep, arr, pln_arr, ts, pax, ac_type, distance, rating, salary, income, pilot_id, pic, pid, fuel_used, flighttype, hours, ac_id, number, deptime, arrtime, pln_deptime, pln_arrtime, route_id, va_id, va
|-
| getReportDetail
| va_id, report_id
| SUCCESS, NOT FOUND
| id, ac_type, ac_id, pic, pilot_id, number, dep, pln_arr, arr, deptime, loc_deptime, arrtime, loc_arrtime, hours, ts, flightstate, rating, ratingreasons, distance, pax, ticket, crew, salary, fuelprice, fuel_bought, fuel_used, profit, version, simrate, multiplier, bonus, cargo, cargo_kg, flighttype, comment, cheat
|-
| getRouteData
| va_id, route_id
| SUCCESS, NOT FOUND
| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype
|-
| getRouteList
| va_id
| SUCCESS, NOT FOUND
| id, number, dep, dep_country, arr, arr_country, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id
|}
===Pilot Data===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| getPeriodPilotStats
| va_id, from_ts, to_ts
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotData
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, budget, lastactive, active, sigac, timezone, weightunit, language, msgmail, flights, rating, hours, distance, pax, cargo_kg
|-
| getPilotHours
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, manufacturer, type, icao, hours
|-
| getPilotList
| va_id
| SUCCESS, NOT FOUND
| id, name, surname, user, va_user, rank_id, location, last_active, status, budget
|-
| getPilotRatings
| va_id, pilot_id
| SUCCESS, NOT FOUND
| id, training, manufacturer, type
|-
| getPilotStats
| va_id
| SUCCESS, NOT FOUND
| id, flights, rating, hours, distance, last, fuel_used, profit, cargo_kg, pax
|-
| getPilotStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| ac_id, route_id, departure, arrival, dep_time, dist, duration, status, lon, lat, flightstate, passengers, income, ticket, timestamp, cargo, multiplier, flighttype
|}

===Flight Booking===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| bookFlight
| va_id, pilot_id, passwd, route_id, ac_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| success, message, codeshare, codeshare_msg
|-
| cancelFlight
| va_id, pilot_id, passwd
| SUCCESS, NOT FOUND
| result, loss
|-
| getBookableRoutes
| va_id, pilot_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id
|-
| getBookableAircraft
| va_id, pilot_id, route_id
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE
| type, registration, state, id, name, fuel
|-
| getBookStatus
| va_id, pilot_id
| SUCCESS, NOT FOUND
| status
|}

===Miscellaneous User Functions===
{| class="wikitable"
! Function
! Parameters
! Return Codes
! Data
|-
| createAccount
| va_id, givenname, surname, username, email, password, airport, accept_pp
| SUCCESS, NOT FOUND
| success, message, code
|-
| getPilotID
| va_id, user, passwd
| SUCCESS, NOT FOUND
| id
|-
| getPrivacyPolicy
| va_id
| SUCCESS
| policy
|-
| getTransferCost
| va_id, arr, dep
| SUCCESS, NOT FOUND
| cost
|-
| transferPilot
| va_id, pilot_id, passwd, icao
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS
| cost
|}

===Notes===
<references />