XML-Interface-v2: Difference between revisions
Joefremont (talk | contribs) Created page with "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 cre..." |
Joefremont (talk | contribs) |
||
(19 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
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 | 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 data from FSAirlines. | ||
'''''This version of the XML interface is now released as official.''''' | |||
==Changes from the previous version== | |||
Compared to the previous version of the XML-Interface the following change were made. | |||
* Change from domain registration to API keys. | |||
* Rate limits added. | |||
* Json output format added. | |||
* Output properly supports UTF-8 character set. | |||
* Additional functions for packages added. | |||
* All array keys are now in lower case. | |||
==Rate limits== | |||
The access to the interface is limited by the number of calls an VA can make each hour and each day. An airline with a gold account can make 500 calls each hour and 6000 call each day. An airline with a platinum account can make 2500 calls each hour and 30000 call each day. If an airline has multiple members then those limits are added together for each premium account. Example if an airline has one platinum member and two gold member there limits are 3500 an hour and 42000 per day. Functions related to pilots booking flights do not count against the rate limits. | |||
==Access Restriction== | ==Access Restriction== | ||
In order to be able to | In order to be able to access data from the Data-Interface you need to create an API key, this can be done using the 'Api Key Management' page. To find this page on the website go to your VA Overview page and then in the options select 'Edit VA Settings' and then 'Api Key Management'. | ||
There are two types of API keys that can be created. | |||
Site key: This key is to be used by your main website/service and may be use the full rate limit allowed by your VA. After one hundred calls using a site api key, the key will be locked to the IP address used. If in the future you need to change the IP address all you need to do is delete the old key and create a new one. | |||
Developer key: This key is used to help you create and test your website on a different machine than your main site. It will not be limited to a single IP address but will be limited to the number of calls each day your VA is normally allowed each hour. Usage of the developer key does apply against your VA's total rate limit. | |||
==Basic Usage== | ==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: | 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/ | <pre>http://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&apikey=xxxxx</pre> | ||
As you can see there is the interface script '' | As you can see there is the interface script ''va_interface2.php'', the function ''getPilotList'' and the parameters ''va_id=7'' and ''apikey=xxxxx''. Some functions require additional parameters, these can be appended after the other parameters. | ||
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: | 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: | ||
Line 18: | Line 34: | ||
<data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" /> | <data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" location="EDDM" lastactive="1286366261" budget="216405101" /> | ||
</fsa_output></pre> | </fsa_output></pre> | ||
Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information. | Inside the ''fsa_output''-tag there are the ''data''-tags which contain all the information. | ||
When calling using this method the default output format is XML, you can get the out in JSON format by adding a format=json parameter to the request. Example: | |||
<pre>https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxx</pre> | |||
The output will be: | |||
<pre> | |||
{ | |||
"status": "SUCCESS", | |||
"data": [ | |||
{ | |||
"id": 1, | |||
"name": "Konrad", | |||
"surname": "Pustka", | |||
"va_user": "SNA101", | |||
"location": "ETSE", | |||
"lastactive": 1600285079, | |||
"budget": 2400628 | |||
}, | |||
{ | |||
"id": 2, | |||
"name": "Claudio", | |||
"surname": "Gusmini", | |||
"va_user": "SNA102", | |||
"location": "LIMG", | |||
"lastactive": 1605458811, | |||
"budget": 216631042 | |||
} | |||
] | |||
} | |||
</pre> | |||
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. | 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> | <pre> | ||
<?php | <?php | ||
$ch = curl_init("https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxxx"); | |||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); | |||
$http_status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); | |||
$http_text = curl_exec($ch); | |||
$objDOM = new DOMDocument(); | $objDOM = new DOMDocument(); | ||
$objDOM-> | $objDOM->loadXML($http_text); | ||
$dataNodes = $objDOM->getElementsByTagName("data"); | $dataNodes = $objDOM->getElementsByTagName("data"); | ||
Line 37: | Line 83: | ||
echo "{$name} {$surname} <br/>"; | echo "{$name} {$surname} <br/>"; | ||
} | } | ||
?> | |||
</pre> | |||
Here is a sample of a PHP script reading the same data in JSON format. | |||
<pre> | |||
<?php | |||
$ch = curl_init("https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxxx"); | |||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); | |||
$http_status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); | |||
$http_text = curl_exec($ch); | |||
$json_data = json_decode($http_text, true); | |||
if ($json_data['status'] == 'SUCCESS') { | |||
foreach($json_data['data'] as $node) { | |||
echo "{$node['name']} {$node['surname']}<br/>\n"; | |||
} | |||
} | |||
</pre> | |||
Here is a sample of a Python script reading the same data in json format. | |||
<pre> | |||
#!/usr/bin/python | |||
import requests | |||
r = requests.get("https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxxx") | |||
json_data = r.json() | |||
if json_data['status'] == 'SUCCESS': | |||
for node in json_data['data']: | |||
print('{} {}'.format(node['name'], node['surname']) | |||
</pre> | |||
==Pilot Login== | |||
Several of the functions require that the pilot calling be logged in. Previous versions of the interface required the call passed the pilots username and a hashed password as parameters. That method has now been discontinued, in this version you will need to call the ''pilotLogin'' to create a token that can be used to call functions for that pilot. Unlike other calls in the interface, the ''pilotLogin'' function is also a HTTP POST call rather than a GET call. Here is an example of calling the ''pilotLogin'' function. | |||
<pre> | |||
<?php | |||
$post = [ | |||
'user' => 'username', | |||
'password' => 'xxxxxxxx' | |||
]; | |||
$ch = curl_init("https://www.fsairlines.net/va_interface2.php?function=pilotLogin&va_id=7&format=json&apikey=xxxxxx"); | |||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); | |||
curl_setopt($ch, CURLOPT_POSTFIELDS, $post); | |||
$http_text = curl_exec($ch); | |||
$data = json_decode($http_text, true); | |||
if ($data['status'] == 'SUCCESS') { | |||
$fsa_token = $data['data']['token']; | |||
} else { | |||
die("Login failed"); | |||
} | |||
</pre> | </pre> | ||
The data returned in this request includes: | |||
{| class="wikitable" | |||
! Parameter | |||
! Meaning | |||
|- | |||
| token | |||
| The pilots login token. | |||
|- | |||
| alt_code | |||
| The alternate ICAO code of the airport they are currently located based on there default simulator. | |||
|- | |||
| budget | |||
| The pilots current budget | |||
|- | |||
| default_sim | |||
| The pilots default simulator. | |||
|- | |||
| location | |||
| The FSA offical ICAO code of the airport the pilot is located. | |||
|- | |||
| name | |||
| The pilots first name | |||
|- | |||
| pilot_id | |||
| The id number of the pilot. | |||
|- | |||
| premium | |||
| 1 of the pilot is a premium member, 0 if not. | |||
|- | |||
| rank | |||
| The code for the pilots rank within their VA | |||
|- | |||
| rank_id | |||
| The id of the pilots rank within their VA | |||
|- | |||
| surname | |||
| The pilots last or given name | |||
|- | |||
| va_id | |||
| The ID of the pilots VA | |||
|- | |||
| va_status | |||
| The pilots within there airline | |||
|- | |||
| va_user | |||
| The pilots ID within their VA. | |||
|- | |||
| weightunit | |||
| The pilots default unit of measure (kg or lb). | |||
|} | |||
==Data== | ==Data== | ||
Line 90: | Line 242: | ||
| icao | | icao | ||
| ICAO code of the airport. | | ICAO code of the airport. | ||
|- | |- | ||
| pilot_id | | pilot_id | ||
Line 112: | Line 258: | ||
| Username of the pilot. | | Username of the pilot. | ||
|- | |- | ||
| | | token | ||
| | | Login token created by the pilotLogin function. | ||
|- | |- | ||
| va_id | | va_id | ||
Line 244: | Line 390: | ||
| SUCCESS, NOT FOUND | | SUCCESS, NOT FOUND | ||
| value, reason | | value, reason | ||
|- | |||
| <span style="background-color:#B9FFC5;">getDailyTransactions | |||
| va_id | |||
| SUCCESS, NOT FOUND | |||
| id ts value reason partner_id fleet_id object_id</span> | |||
|} | |} | ||
Line 271: | Line 422: | ||
| va_id, report_id | | va_id, report_id | ||
| SUCCESS, NOT FOUND | | 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, <span style="background-color:#B9FFC5;">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</span> | | 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, <span style="background-color:#B9FFC5;">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, landing_fee</span> | ||
|- | |- | ||
| getRouteData | | getRouteData | ||
Line 335: | Line 486: | ||
|- | |- | ||
| bookFlight | | bookFlight | ||
| va_id, pilot_id, | | va_id, pilot_id, token, route_id, ac_id | ||
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | | SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | ||
| success, message, codeshare, codeshare_msg | | success, message, codeshare, codeshare_msg | ||
|- | |- | ||
| cancelFlight | | cancelFlight | ||
| va_id, pilot_id, | | va_id, pilot_id, token | ||
| SUCCESS, NOT FOUND | | SUCCESS, NOT FOUND | ||
| result, loss | | result, loss | ||
|- | |- | ||
| getBookableRoutes | | getBookableRoutes | ||
| va_id, pilot_id | | va_id, pilot_id, token | ||
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | | SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | ||
| number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id | | number, dep, arr, deptime, arrtime, id, state, simrate, flighttype, training, price, list, ac_id | ||
|- | |- | ||
| getBookableAircraft | | getBookableAircraft | ||
| va_id, pilot_id, route_id | | va_id, pilot_id, route_id, token | ||
| SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | | SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | ||
| type, registration, state, id, name, fuel | | type, registration, state, id, name, fuel | ||
Line 373: | Line 524: | ||
|- | |- | ||
| getPilotID | | getPilotID | ||
| va_id, user, | | va_id, user, token | ||
| SUCCESS, NOT FOUND | | SUCCESS, NOT FOUND | ||
| id | | id | ||
Line 388: | Line 539: | ||
|- | |- | ||
| transferPilot | | transferPilot | ||
| va_id, pilot_id, | | va_id, pilot_id, token, icao | ||
| SUCCESS, NOT FOUND, INSUFFICIENT FUNDS | | SUCCESS, NOT FOUND, INSUFFICIENT FUNDS | ||
| cost | | cost | ||
Line 402: | Line 553: | ||
| metar | | metar | ||
|} | |} | ||
===Package Functions=== | |||
{| class="wikitable" | |||
! Function | |||
! Parameters | |||
! Return Codes | |||
! Data | |||
|- | |||
| getAirportPackageSummary | |||
| va_id, icao | |||
| SUCCESS, NOT FOUND | |||
| | |||
|- | |||
| getVaPackageSummary | |||
| va_id | |||
| SUCCESS, NOT FOUND | |||
| | |||
|- | |||
| getAircraftPackages | |||
| va_id, ac_id | |||
| SUCCESS, NOT FOUND | |||
| | |||
|- | |||
| getCenterPackages | |||
| va_id, center_id | |||
| SUCCESS, NOT FOUND | |||
| | |||
|} | |||
'''Sample Responses''' | |||
'''getAirportPackageSummary''' | |||
<pre> | |||
{ | |||
"status": "SUCCESS", | |||
"data": { | |||
"arr": { | |||
"EDDK": { | |||
"100000": 1, | |||
"200": 12, | |||
"2000": 2, | |||
"bearing": 29.528874983699, | |||
"city": "Cologne-Bonn", | |||
"distance": 4872.3920956341, | |||
"total_kg": 106400 | |||
}, | |||
"KBFL": { | |||
"200": 16, | |||
"40": 310, | |||
"bearing": 128.34209940912, | |||
"city": "Bakersfield", | |||
"distance": 207.19199031933, | |||
"total_kg": 15600 | |||
}, | |||
} | |||
} | |||
} | |||
</pre> | |||
'''getVaPackageSummary''' | |||
<pre> | |||
{ | |||
"status": "SUCCESS", | |||
"data": { | |||
"aircraft": [ | |||
{ | |||
"ac_id": 129691, | |||
"earliest_ts": 1622293737, | |||
"location": "EDDF", | |||
"packages": 13, | |||
"registration": "D-AOGT", | |||
"size_kg": 26000 | |||
} | |||
], | |||
"centers": [ | |||
{ | |||
"center_id": 4347, | |||
"description": "Himalayan Transport", | |||
"earliest_ts": 1621459008, | |||
"location": "VNKT", | |||
"packages": 82, | |||
"size_kg": 4080 | |||
} | |||
] | |||
} | |||
} | |||
</pre> | |||
Response Values | |||
<ul> | |||
<li>earliest_ts: The timestamp the of the oldest package in that aircraft/center | |||
<li>packages: The count of packages stored | |||
<li>size_kg: The total weight in kg of the packages stored. | |||
</ul> | |||
'''getAircraftPackages''' | |||
'''getCenterPackages''' | |||
<pre> | |||
{ | |||
"status": "SUCCESS", | |||
"data": [ | |||
{ | |||
"ac_id": 129691, | |||
"arr": "SBGL", | |||
"arr_city": "Rio De Janeiro", | |||
"center_id": null, | |||
"created_ts": 1620830486, | |||
"delivered": false, | |||
"dep": "EDDF", | |||
"fleet_id": 72303, | |||
"id": 302216085, | |||
"location": "EDDF", | |||
"mult": 10, | |||
"package_type": 0, | |||
"payment": 59281, | |||
"payment_fact": null, | |||
"pilot_id": 98096, | |||
"size_kg": 2000, | |||
"start_ts": 1622293737, | |||
"updated_ts": 1620830486 | |||
}, | |||
] | |||
} | |||
</pre> | |||
Response Values | |||
<ul> | |||
<li>ac_id: The id of the aircraft holding the package | |||
<li>arr: The ICAO of the destination airport | |||
<li>arr_city: The city name of the destination airport | |||
<li>center_id: The id center holding the aircraft | |||
<li>created_ts: The unix timestamp of the the package was created. | |||
<li>dep: The ICAO of the origin airport | |||
<li>fleet_id: The fleet that picked up the package | |||
<li>location: The airport the package is currently located | |||
<li>mult: The VA financial multiplier when the package was picked up | |||
<li>package_type: 0 for normal, 1 for priority | |||
<li>payment: The base payment for when the package was created. | |||
<li>pilot_id: The ID of the pilot who picked up the package. | |||
<li>size_kg: The size in kg of the package | |||
<li>start_ts: The unix timestamp of when the package was picked up. | |||
</ul> | |||
===Notes=== | ===Notes=== |
Latest revision as of 14:37, 11 September 2024
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 data from FSAirlines.
This version of the XML interface is now released as official.
Changes from the previous version
Compared to the previous version of the XML-Interface the following change were made.
- Change from domain registration to API keys.
- Rate limits added.
- Json output format added.
- Output properly supports UTF-8 character set.
- Additional functions for packages added.
- All array keys are now in lower case.
Rate limits
The access to the interface is limited by the number of calls an VA can make each hour and each day. An airline with a gold account can make 500 calls each hour and 6000 call each day. An airline with a platinum account can make 2500 calls each hour and 30000 call each day. If an airline has multiple members then those limits are added together for each premium account. Example if an airline has one platinum member and two gold member there limits are 3500 an hour and 42000 per day. Functions related to pilots booking flights do not count against the rate limits.
Access Restriction
In order to be able to access data from the Data-Interface you need to create an API key, this can be done using the 'Api Key Management' page. To find this page on the website go to your VA Overview page and then in the options select 'Edit VA Settings' and then 'Api Key Management'.
There are two types of API keys that can be created.
Site key: This key is to be used by your main website/service and may be use the full rate limit allowed by your VA. After one hundred calls using a site api key, the key will be locked to the IP address used. If in the future you need to change the IP address all you need to do is delete the old key and create a new one.
Developer key: This key is used to help you create and test your website on a different machine than your main site. It will not be limited to a single IP address but will be limited to the number of calls each day your VA is normally allowed each hour. Usage of the developer key does apply against your VA's total rate limit.
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:
http://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&apikey=xxxxx
As you can see there is the interface script va_interface2.php, the function getPilotList and the parameters va_id=7 and apikey=xxxxx. Some functions require additional parameters, these can be appended after the other parameters.
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:
<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>
Inside the fsa_output-tag there are the data-tags which contain all the information.
When calling using this method the default output format is XML, you can get the out in JSON format by adding a format=json parameter to the request. Example:
https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxx
The output will be:
{ "status": "SUCCESS", "data": [ { "id": 1, "name": "Konrad", "surname": "Pustka", "va_user": "SNA101", "location": "ETSE", "lastactive": 1600285079, "budget": 2400628 }, { "id": 2, "name": "Claudio", "surname": "Gusmini", "va_user": "SNA102", "location": "LIMG", "lastactive": 1605458811, "budget": 216631042 } ] }
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.
<?php $ch = curl_init("https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxxx"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $http_status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); $http_text = curl_exec($ch); $objDOM = new DOMDocument(); $objDOM->loadXML($http_text); $dataNodes = $objDOM->getElementsByTagName("data"); foreach( $dataNodes as $node ) { $name = $node->getAttribute("name"); $surname = $node->getAttribute("surname"); echo "{$name} {$surname} <br/>"; }
Here is a sample of a PHP script reading the same data in JSON format.
<?php $ch = curl_init("https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxxx"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $http_status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); $http_text = curl_exec($ch); $json_data = json_decode($http_text, true); if ($json_data['status'] == 'SUCCESS') { foreach($json_data['data'] as $node) { echo "{$node['name']} {$node['surname']}<br/>\n"; } }
Here is a sample of a Python script reading the same data in json format.
#!/usr/bin/python import requests r = requests.get("https://www.fsairlines.net/va_interface2.php?function=getPilotList&va_id=7&format=json&apikey=xxxxxx") json_data = r.json() if json_data['status'] == 'SUCCESS': for node in json_data['data']: print('{} {}'.format(node['name'], node['surname'])
Pilot Login
Several of the functions require that the pilot calling be logged in. Previous versions of the interface required the call passed the pilots username and a hashed password as parameters. That method has now been discontinued, in this version you will need to call the pilotLogin to create a token that can be used to call functions for that pilot. Unlike other calls in the interface, the pilotLogin function is also a HTTP POST call rather than a GET call. Here is an example of calling the pilotLogin function.
<?php $post = [ 'user' => 'username', 'password' => 'xxxxxxxx' ]; $ch = curl_init("https://www.fsairlines.net/va_interface2.php?function=pilotLogin&va_id=7&format=json&apikey=xxxxxx"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $post); $http_text = curl_exec($ch); $data = json_decode($http_text, true); if ($data['status'] == 'SUCCESS') { $fsa_token = $data['data']['token']; } else { die("Login failed"); }
The data returned in this request includes:
Parameter | Meaning |
---|---|
token | The pilots login token. |
alt_code | The alternate ICAO code of the airport they are currently located based on there default simulator. |
budget | The pilots current budget |
default_sim | The pilots default simulator. |
location | The FSA offical ICAO code of the airport the pilot is located. |
name | The pilots first name |
pilot_id | The id number of the pilot. |
premium | 1 of the pilot is a premium member, 0 if not. |
rank | The code for the pilots rank within their VA |
rank_id | The id of the pilots rank within their VA |
surname | The pilots last or given name |
va_id | The ID of the pilots VA |
va_status | The pilots within there airline |
va_user | The pilots ID within their VA. |
weightunit | The pilots default unit of measure (kg or lb). |
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.
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. |
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. |
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. |
token | Login token created by the pilotLogin function. |
va_id | ID of the Virtual Airline. Is displayed on the Overview page. |
Aircraft Data
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
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
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
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 |
getDailyTransactions | va_id | SUCCESS, NOT FOUND | id ts value reason partner_id fleet_id object_id |
Flight Data
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, landing_fee |
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
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
Function | Parameters | Return Codes | Data |
---|---|---|---|
bookFlight | va_id, pilot_id, token, route_id, ac_id | SUCCESS, NOT FOUND, FLIGHT BOOKED, GROUNDED, SUSPENDED, VA INACTIVE | success, message, codeshare, codeshare_msg |
cancelFlight | va_id, pilot_id, token | SUCCESS, NOT FOUND | result, loss |
getBookableRoutes | va_id, pilot_id, token | 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, token | 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
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, token | SUCCESS, NOT FOUND | id |
getPrivacyPolicy | va_id | SUCCESS | policy |
getTransferCost | va_id, arr, dep | SUCCESS, NOT FOUND | cost |
transferPilot | va_id, pilot_id, token, 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 |
Package Functions
Function | Parameters | Return Codes | Data |
---|---|---|---|
getAirportPackageSummary | va_id, icao | SUCCESS, NOT FOUND | |
getVaPackageSummary | va_id | SUCCESS, NOT FOUND | |
getAircraftPackages | va_id, ac_id | SUCCESS, NOT FOUND | |
getCenterPackages | va_id, center_id | SUCCESS, NOT FOUND |
Sample Responses
getAirportPackageSummary
{ "status": "SUCCESS", "data": { "arr": { "EDDK": { "100000": 1, "200": 12, "2000": 2, "bearing": 29.528874983699, "city": "Cologne-Bonn", "distance": 4872.3920956341, "total_kg": 106400 }, "KBFL": { "200": 16, "40": 310, "bearing": 128.34209940912, "city": "Bakersfield", "distance": 207.19199031933, "total_kg": 15600 }, } } }
getVaPackageSummary
{ "status": "SUCCESS", "data": { "aircraft": [ { "ac_id": 129691, "earliest_ts": 1622293737, "location": "EDDF", "packages": 13, "registration": "D-AOGT", "size_kg": 26000 } ], "centers": [ { "center_id": 4347, "description": "Himalayan Transport", "earliest_ts": 1621459008, "location": "VNKT", "packages": 82, "size_kg": 4080 } ] } }
Response Values
- earliest_ts: The timestamp the of the oldest package in that aircraft/center
- packages: The count of packages stored
- size_kg: The total weight in kg of the packages stored.
getAircraftPackages getCenterPackages
{ "status": "SUCCESS", "data": [ { "ac_id": 129691, "arr": "SBGL", "arr_city": "Rio De Janeiro", "center_id": null, "created_ts": 1620830486, "delivered": false, "dep": "EDDF", "fleet_id": 72303, "id": 302216085, "location": "EDDF", "mult": 10, "package_type": 0, "payment": 59281, "payment_fact": null, "pilot_id": 98096, "size_kg": 2000, "start_ts": 1622293737, "updated_ts": 1620830486 }, ] }
Response Values
- ac_id: The id of the aircraft holding the package
- arr: The ICAO of the destination airport
- arr_city: The city name of the destination airport
- center_id: The id center holding the aircraft
- created_ts: The unix timestamp of the the package was created.
- dep: The ICAO of the origin airport
- fleet_id: The fleet that picked up the package
- location: The airport the package is currently located
- mult: The VA financial multiplier when the package was picked up
- package_type: 0 for normal, 1 for priority
- payment: The base payment for when the package was created.
- pilot_id: The ID of the pilot who picked up the package.
- size_kg: The size in kg of the package
- start_ts: The unix timestamp of when the package was picked up.
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