Difference between revisions of "Official FSAirlines Integration Pack"

From FSAirlinesWiki
Jump to: navigation, search
(Demos)
m (Reverted edits by Darcybarron (talk) to last revision by Alasizon)
 
(63 intermediate revisions by 23 users not shown)
Line 1: Line 1:
 
[[Category:Website Integration Packs]]
 
[[Category:Website Integration Packs]]
The official Integration Pack
+
{{Infobox integration pack
 +
|Version=1.0
 +
|Date=September 9th, 2010
 +
|Developers=[[User:Konny|Konny]]
 +
Joe
 +
|Svn path=/trunk
 +
}}
  
 
==How to use==
 
==How to use==
==General options==
+
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:
Currently supported CGI Parameters
+
<pre><iframe width="600" height="500" src="http://remote.fsairlines.net/v1/roster.php?rvi=368&title=off">
 +
  <p>Your browser does not support iframes.</p>
 +
</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"
 
{| class="wikitable"
| rvi=XXX
+
| '''rvi=XXX'''
| Virtual Airline ID number
+
| '''Virtual Airline ID number (mandatory)'''
 
|-
 
|-
 
| lng=XX
 
| lng=XX
Line 42: Line 61:
 
| Data Row 2 Color, Six letter HTML Color code
 
| Data Row 2 Color, Six letter HTML Color code
 
|}
 
|}
 +
 
==Pages==
 
==Pages==
 +
The following table shows all the pages which you can include in your own VA website.
 
{| class="wikitable"
 
{| class="wikitable"
 
| Roster
 
| Roster
| http://remote.fsairlines.net/beta/roster.php?rvi=368
+
| http://remote.fsairlines.net/v1/roster.php?rvi=368
 
|-
 
|-
 
| Roster ( Alternate )
 
| Roster ( Alternate )
| http://remote.fsairlines.net/beta/roster_2.php?rvi=368
+
| http://remote.fsairlines.net/v1/roster_2.php?rvi=368
 
|-
 
|-
 
| Fleet
 
| Fleet
| http://remote.fsairlines.net/beta/fleet.php?rvi=368
+
| http://remote.fsairlines.net/v1/fleet.php?rvi=368
 
|-
 
|-
 
| Fleet ( Alternate )
 
| Fleet ( Alternate )
| http://remote.fsairlines.net/beta/fleet_2.php?rvi=368
+
| http://remote.fsairlines.net/v1/fleet_2.php?rvi=368
 
|-
 
|-
 
| Timetable
 
| Timetable
| http://remote.fsairlines.net/beta/timetable.php?rvi=368
+
| http://remote.fsairlines.net/v1/timetable.php?rvi=368
 
|-
 
|-
 
| Timetable ( Alternate )
 
| Timetable ( Alternate )
| http://remote.fsairlines.net/beta/timetable_2.php?rvi=368
+
| http://remote.fsairlines.net/v1/timetable_2.php?rvi=368
 
|-
 
|-
 
| Flight Reports ( Pireps )
 
| Flight Reports ( Pireps )
| http://remote.fsairlines.net/beta/pireps.php?rvi=368
+
| http://remote.fsairlines.net/v1/pireps.php?rvi=368
 
|-
 
|-
 
| Financial Report
 
| Financial Report
| http://remote.fsairlines.net/beta/finance.php?rvi=368
+
| http://remote.fsairlines.net/v1/finance.php?rvi=368
 
|-
 
|-
 
| Reliability Report
 
| Reliability Report
| http://remote.fsairlines.net/beta/reliability.php?rvi=368
+
| http://remote.fsairlines.net/v1/reliability.php?rvi=368
 
|-
 
|-
 
| Pilot Stats
 
| Pilot Stats
| http://remote.fsairlines.net/beta/pilotstats.php?rvi=368
+
| http://remote.fsairlines.net/v1/pilotstats.php?rvi=368
 
|-
 
|-
 
| Monthly Pilot Stats
 
| Monthly Pilot Stats
| http://remote.fsairlines.net/beta/mpilotstats.php?rvi=368
+
| http://remote.fsairlines.net/v1/mpilotstats.php?rvi=368
 
|-
 
|-
 
| Fleet Stats
 
| Fleet Stats
| http://remote.fsairlines.net/beta/fleetstats.php?rvi=368
+
| http://remote.fsairlines.net/v1/fleetstats.php?rvi=368
 
|-
 
|-
 
| Monthly Fleet Stats
 
| Monthly Fleet Stats
| http://remote.fsairlines.net/beta/mfleetstats.php?rvi=368
+
| http://remote.fsairlines.net/v1/mfleetstats.php?rvi=368
 
|-
 
|-
 
| Country Stats
 
| Country Stats
| http://remote.fsairlines.net/beta/countrystats.php?rvi=368
+
| http://remote.fsairlines.net/v1/countrystats.php?rvi=368
 
|-
 
|-
 
| Dispatch Office
 
| Dispatch Office
| http://remote.fsairlines.net/beta/dispatch.php?rvi=368
+
| http://remote.fsairlines.net/v1/dispatch.php?rvi=368
 
|-
 
|-
 
| Pilot Registration & Application (*)
 
| Pilot Registration & Application (*)
| http://remote.fsairlines.net/beta/application.php?rvi=368
+
| http://remote.fsairlines.net/v1/application.php?rvi=368
 
|-
 
|-
 
| Infobox
 
| Infobox
| http://remote.fsairlines.net/beta/infobox.php?rvi=368
+
| http://remote.fsairlines.net/v1/infobox.php?rvi=368
 
|-
 
|-
 
| Infobox ( Alternate )
 
| Infobox ( Alternate )
| http://remote.fsairlines.net/beta/infobox2.php?rvi=368
+
| http://remote.fsairlines.net/v1/infobox2.php?rvi=368
 
|-
 
|-
 
| Booked Flights
 
| Booked Flights
| http://remote.fsairlines.net/beta/flights_booked.php?rvi=368
+
| http://remote.fsairlines.net/v1/flights_booked.php?rvi=368
 
|-
 
|-
 
| Active Flights
 
| Active Flights
| http://remote.fsairlines.net/beta/flights_active.php?rvi=368
+
| http://remote.fsairlines.net/v1/flights_active.php?rvi=368
 
|-
 
|-
 
| Active Flights ( Alternate )
 
| Active Flights ( Alternate )
| http://remote.fsairlines.net/beta/flights_active2.php?rvi=368
+
| http://remote.fsairlines.net/v1/flights_active2.php?rvi=368
 
|-
 
|-
 
| Last Flights
 
| Last Flights
| http://remote.fsairlines.net/beta/lastflights.php?rvi=368
+
| http://remote.fsairlines.net/v1/lastflights.php?rvi=368
 
|}
 
|}
  
 
==Demos==
 
==Demos==
 +
Here can have a look at how the pages of the Integration Pack look like.
 
===Basic VA data===
 
===Basic VA data===
  
Line 117: Line 139:
 
   <div class="NavHead">Roster</div>
 
   <div class="NavHead">Roster</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/roster.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/roster.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 124: Line 146:
 
   <div class="NavHead">Roster (Alternate)</div>
 
   <div class="NavHead">Roster (Alternate)</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/roster_2.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/roster_2.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 131: Line 153:
 
   <div class="NavHead">Fleet</div>
 
   <div class="NavHead">Fleet</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/fleet.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/fleet.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 138: Line 160:
 
   <div class="NavHead">Fleet (Alternate)</div>
 
   <div class="NavHead">Fleet (Alternate)</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/fleet_2.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/fleet_2.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 145: Line 167:
 
   <div class="NavHead">Timetable</div>
 
   <div class="NavHead">Timetable</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/timetable.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/timetable.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 152: Line 174:
 
   <div class="NavHead">Timetable (Alternate)</div>
 
   <div class="NavHead">Timetable (Alternate)</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/timetable_2.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/timetable_2.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 161: Line 183:
 
   <div class="NavHead">Flight Reports (PIREPs)</div>
 
   <div class="NavHead">Flight Reports (PIREPs)</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/pireps.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/pireps.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 168: Line 190:
 
   <div class="NavHead">Financial Report</div>
 
   <div class="NavHead">Financial Report</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/finance.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/finance.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 175: Line 197:
 
   <div class="NavHead">Reliability Report</div>
 
   <div class="NavHead">Reliability Report</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/reliability.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/reliability.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 184: Line 206:
 
   <div class="NavHead">Pilot Stats</div>
 
   <div class="NavHead">Pilot Stats</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/pilotstats.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/pilotstats.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 191: Line 213:
 
   <div class="NavHead">Monthly Pilot Stats</div>
 
   <div class="NavHead">Monthly Pilot Stats</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/mpilotstats.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/mpilotstats.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 198: Line 220:
 
   <div class="NavHead">Fleet Stats</div>
 
   <div class="NavHead">Fleet Stats</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/fleetstats.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/fleetstats.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 205: Line 227:
 
   <div class="NavHead">Monthly Fleet Stats</div>
 
   <div class="NavHead">Monthly Fleet Stats</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/mfleetstats.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/mfleetstats.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 212: Line 234:
 
   <div class="NavHead">Country Stats</div>
 
   <div class="NavHead">Country Stats</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/countrystats.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/countrystats.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 219: Line 241:
 
   <div class="NavHead">Infobox</div>
 
   <div class="NavHead">Infobox</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/infobox.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/infobox.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 226: Line 248:
 
   <div class="NavHead">Infobo (Alternate)</div>
 
   <div class="NavHead">Infobo (Alternate)</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/infobox2.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/infobox2.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 235: Line 257:
 
   <div class="NavHead">Dispatch Office</div>
 
   <div class="NavHead">Dispatch Office</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/dispatch.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/dispatch.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 242: Line 264:
 
   <div class="NavHead">Pilot Registration & Application</div>
 
   <div class="NavHead">Pilot Registration & Application</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/application.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/application.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 251: Line 273:
 
   <div class="NavHead">Booked Flights</div>
 
   <div class="NavHead">Booked Flights</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/flights_booked.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/flights_booked.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 258: Line 280:
 
   <div class="NavHead">Active Flights</div>
 
   <div class="NavHead">Active Flights</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/flights_active.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/flights_active.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 265: Line 287:
 
   <div class="NavHead">Active Flights (Alternate)</div>
 
   <div class="NavHead">Active Flights (Alternate)</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/flights_active2.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/flights_active2.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>
Line 272: Line 294:
 
   <div class="NavHead">Last Flights</div>
 
   <div class="NavHead">Last Flights</div>
 
   <div class="NavContent">
 
   <div class="NavContent">
     <anyweb>http://remote.fsairlines.net/beta/lastflights.php?rvi=7&title=off</anyweb>
+
     <anyweb>http://remote.fsairlines.net/v1/lastflights.php?rvi=7&title=off</anyweb>
 
   </div>
 
   </div>
 
</div>
 
</div>

Latest revision as of 02:12, 20 October 2012

Official FSAirlines Integration Pack Overview
Version 1.0
Date September 9th, 2010
Developers Konny

Joe

Subversion 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 <iframe> HTML-Tag. Here's an example HTML-code:

<iframe width="600" height="500" src="http://remote.fsairlines.net/v1/roster.php?rvi=368&title=off">
   <p>Your browser does not support iframes.</p>
</iframe>

The src="..." part determines which data is shown. Just copy the required url from the list of pages. There are several 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 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 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.

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.

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

Reports

Statistics

Interactive

Flights