XML-Interface-v2 - Revision history

Joefremont: /* Flight Data */

2025-05-10T19:23:18Z

Flight Data

← Older revision		Revision as of 19:23, 10 May 2025
Line 415:		Line 415:
	\|-		\|-
	\| getFlightReports		\| getFlightReports
	\| va_id, (acdb_id), (ac_id), (pilot_id), (days), (count)		\| va_id, (acdb_id), (ac_id), (fleet_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, <span style="background-color:#B9FFC5;">pax_economy, pax_business, pax_first</span>		\| 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>

Joefremont: /* Flight Data */

2024-09-11T14:37:35Z

Flight Data

← Older revision		Revision as of 14:37, 11 September 2024
Line 417:		Line 417:
	\| 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, <span style="background-color:#B9FFC5;">pax_economy, pax_business, pax_first~~, landing_fee~~</span>		\| 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, <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

Joefremont: /* Flight Data */

2024-09-11T14:36:40Z

Flight Data

← Older revision		Revision as of 14:36, 11 September 2024
Line 417:		Line 417:
	\| 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, <span style="background-color:#B9FFC5;">pax_economy, pax_business, pax_first</span>		\| 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, landing_fee</span>
	\|-		\|-
	\| getReportDetail		\| getReportDetail

Joefremont: /* Changes from the previous version */

2024-08-15T21:21:30Z

Changes from the previous version

← Older revision		Revision as of 21:21, 15 August 2024
Line 10:		Line 10:
	* Output properly supports UTF-8 character set.		* Output properly supports UTF-8 character set.
	* Additional functions for packages added.		* Additional functions for packages added.
			* All array keys are now in lower case.

	==Rate limits==		==Rate limits==

Joefremont: /* Basic Usage */

2024-08-01T18:55:59Z

Basic Usage

← Older revision		Revision as of 18:55, 1 August 2024
Line 26:		Line 26:
	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_interface2.php?function=getPilotList&va_id=7&apikey=xxxxx</pre>		<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 ''~~va_interface~~.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.		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 112:		Line 112:

	</pre>		</pre>

	==Pilot Login==		==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.		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.

Joefremont: /* Financial Data */

2024-07-10T22:07:46Z

Financial Data

← Older revision		Revision as of 22:07, 10 July 2024
Line 389:		Line 389:
	\| value, reason		\| value, reason
	\|-		\|-
	\| getDailyTransactions		\| <span style="background-color:#B9FFC5;">getDailyTransactions
	\| va_id		\| va_id
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| id ts value reason partner_id fleet_id object_id		\| id ts value reason partner_id fleet_id object_id</span>
	\|}		\|}

Joefremont: /* Financial Data */

2024-07-10T22:06:16Z

Financial Data

← Older revision		Revision as of 22:06, 10 July 2024
Line 388:		Line 388:
	\| SUCCESS, NOT FOUND		\| SUCCESS, NOT FOUND
	\| value, reason		\| value, reason
			\|-
			\| getDailyTransactions
			\| va_id
			\| SUCCESS, NOT FOUND
			\| id ts value reason partner_id fleet_id object_id
	\|}		\|}

Joefremont: /* Rate limits */

2023-07-06T23:42:10Z

Rate limits

← Older revision		Revision as of 23:42, 6 July 2023
Line 12:		Line 12:

	==Rate limits==		==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 ~~100~~ calls each hour and ~~1200~~ call each day. An airline with a platinum account can make ~~500~~ calls each hour and ~~6000~~ 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 ~~700~~ an hour and ~~8400~~ per day. Functions related to pilots booking flights do not count against the 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==

Joefremont at 23:37, 6 July 2023

2023-07-06T23:37:59Z

← Older revision		Revision as of 23:37, 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 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 data from FSAirlines.

	'''''This version of the XML interface is now released as ~~beta~~.'''''		'''''This version of the XML interface is now released as official.'''''

	==Changes from the previous version==		==Changes from the previous version==

Joefremont: /* Flight Booking */

2021-06-07T20:47:50Z

Flight Booking

← Older revision		Revision as of 20:47, 7 June 2021
Line 490:		Line 490:
	\|-		\|-
	\| 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