XML-Interface - Revision history

Joefremont at 23:39, 6 July 2023

2023-07-06T23:39:21Z

← Older revision		Revision as of 23:39, 6 July 2023
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 XML data from FSAirlines.		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.

			'''This interface is officially deprecated, all functions using username and password will be disabled 1 August 2023'''

	==Access Restriction==		==Access Restriction==

Joefremont: /* Basic Usage */

2016-07-08T15:35:43Z

Basic Usage

← Older revision		Revision as of 15:35, 8 July 2016
Line 10:		Line 10:
	==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/va_interface.~~php5~~?function=getPilotList&va_id=7</pre>		<pre>http://www.fsairlines.net/va_interface.php?function=getPilotList&va_id=7</pre>
	As you can see there is the interface script ''va_interface.php'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.		As you can see there is the interface script ''va_interface.php'', the function ''getPilotList'' and one function parameter ''va_id=7''. Some functions require additional parameters, these can be appended after the ''va_id''.

Joefremont: /* Basic Usage */

2016-07-08T15:34:48Z

Basic Usage

← Older revision		Revision as of 15:34, 8 July 2016
Line 11:		Line 11:
	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/va_interface.php5?function=getPilotList&va_id=7</pre>		<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''.		As you can see there is the interface script ''va_interface.php'', 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:		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 25:		Line 25:
	<?php		<?php
	$objDOM = new DOMDocument();		$objDOM = new DOMDocument();
	$objDOM->load("http://www.fsairlines.net/va_interface.~~php5~~?function=getPilotList&va_id=7");		$objDOM->load("http://www.fsairlines.net/va_interface.php?function=getPilotList&va_id=7");

	//uncomment to show raw xml-data		//uncomment to show raw xml-data

Konny: /* Flight Data */

2013-01-12T00:34:42Z

Flight Data

← Older revision		Revision as of 00:34, 12 January 2013
Line 256:		Line 256:
	\| va_id		\| va_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat, ~~<span style="background-color:#B9FFC5;">~~pax_economy, pax_business, pax_first~~</span>~~		\| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat, pax_economy, pax_business, pax_first
	\|-		\|-
	\| getBookedFlights		\| getBookedFlights
	\| va_id		\| va_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| departure, arrival, passengers, cargo, user_id, ac_id, number, ~~<span style="background-color:#B9FFC5;">~~pax_economy, pax_business, pax_first~~</span>~~		\| departure, arrival, passengers, cargo, user_id, ac_id, number, pax_economy, pax_business, pax_first
	\|-		\|-
	\| getFlightReports		\| getFlightReports
	\| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)		\| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)
	\| SUCCESS, NOT FOUND		\| 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		\| 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, <span style="background-color:#B9FFC5;">pax_economy, pax_business, pax_first</span>
	\|-		\|-
	\| getReportDetail		\| getReportDetail
	\| 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, 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		\| 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>
	\|-		\|-
	\| getRouteData		\| getRouteData
	\| va_id, route_id		\| va_id, route_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, ~~<span style="background-color:#B9FFC5;">~~route, limit_pax, limit_cargo~~</span>~~		\| 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		\| getRouteList

Konny: /* Flight Data */

2013-01-12T00:31:34Z

Flight Data

← Older revision		Revision as of 00:31, 12 January 2013
Line 271:		Line 271:
	\| 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		\| 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		\| getRouteData

Konny: /* Flight Data */

2012-12-07T23:13:50Z

Flight Data

← Older revision		Revision as of 23:13, 7 December 2012
Line 256:		Line 256:
	\| va_id		\| va_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat		\| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat, <span style="background-color:#B9FFC5;">pax_economy, pax_business, pax_first</span>
	\|-		\|-
	\| getBookedFlights		\| getBookedFlights

Konny: /* Flight Data */

2012-12-02T18:31:27Z

Flight Data

← Older revision		Revision as of 18:31, 2 December 2012
Line 261:		Line 261:
	\| va_id		\| va_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| departure, arrival, passengers, cargo, user_id, ac_id, number		\| departure, arrival, passengers, cargo, user_id, ac_id, number, <span style="background-color:#B9FFC5;">pax_economy, pax_business, pax_first</span>
	\|-		\|-
	\| getFlightReports		\| getFlightReports

Konny: /* Flight Data */

2012-12-02T18:25:36Z

Flight Data

← Older revision		Revision as of 18:25, 2 December 2012
Line 249:		Line 249:
	{\| class="wikitable"		{\| class="wikitable"
	! Function		! Function
	! Parameters in brackets are optional~~</ref>~~		! Parameters in brackets are optional
	! Return Codes		! Return Codes
	! Data		! Data

Konny: /* Flight Data */

2012-12-02T18:25:04Z

Flight Data

← Older revision		Revision as of 18:25, 2 December 2012
Line 249:		Line 249:
	{\| class="wikitable"		{\| class="wikitable"
	! Function		! Function
	! ~~Parameters<ref name="params">~~Parameters in brackets are optional</ref>		! Parameters in brackets are optional</ref>
	! Return Codes		! Return Codes
	! Data		! Data
Line 256:		Line 256:
	\| va_id		\| va_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, ~~<span style="background-color:#B9FFC5;">~~lon, lat~~</span>~~		\| departure, arrival, passengers, cargo, user_id, ac_id, flightstate, timestamp, number, lon, lat
	\|-		\|-
	\| getBookedFlights		\| getBookedFlights
Line 276:		Line 276:
	\| va_id, route_id		\| va_id, route_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype		\| id, va_id, cs_vaid, number, dep, arr, deptime, arrtime, simrate, days, price, state, flighttype, acdb_list, ac_id, remarks, <span style="background-color:#B9FFC5;">route, limit_pax, limit_cargo</span>
	\|-		\|-
	\| getRouteList		\| getRouteList

Konny: /* Aircraft Data */

2012-09-12T13:56:31Z

Aircraft Data

← Older revision		Revision as of 13:56, 12 September 2012
Line 129:		Line 129:
	\| va_id, ac_id		\| va_id, ac_id
	\| SUCCESS, NOT FOUND		\| 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		\| 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		\| getAircraftDBData