XML-Interface

From FSAirlinesWiki
Revision as of 18:56, 17 October 2010 by Konny (Talk | contribs) (New page: The XML-Interface is the core of the VA Integration Kit. It has been designed to enable Virtual Airlines to show nearly any kind of data live on their homepage. The data received i...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The XML-Interface is the core of the VA Integration Kit. It has been designed to enable Virtual Airlines to show nearly any kind of data live on their homepage. The data received is in the XML-format so an airline adapt it to their own homepage design.

Basic Usage

The data can be received by 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_interface.php5?function=getPilotList&va_id=7

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 base-tag being <fsa_output>. This tag has the attributes version and success which show the version number of the interface and the 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" rank_id="1776" location="EDDM" lastactive="1287330550" status="" budget="198144" />
  <data id="2" name="Claudio" surname="Gusmini" va_user="SNA102" rank_id="1776" location="EDDM" lastactive="1286366261" status="" budget="216405101" />
</fsa_output>

Inside the fsa_output-tag there are all 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.

Data

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

Aircraft Data

Function Parameters<ref>All parameters are mandatory</ref> Return Codes Data
getAircraftDBData va_id, acdb_id SUCCESS, NOT FOUND ID, Manufacturer, Type, ICAO, Passengers, Price, Fuel, DOW, MTOW, Speed, Engines, Cargo, MZFW, Market_Only, Range
getAircraftList va_id SUCCESS, NOT FOUND ID, ACDB_ID, ICAO, value, location, Registration

Reports

Statistics

Interactive

Flights

<references />