Official FSAirlines Integration Pack: Difference between revisions

From FSAirlinesWiki
Jump to navigation Jump to search
← Older edit
 
(73 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==
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:
<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"
| '''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
|}


==General Usage==
==Style Options==
==Pages==
==Pages==
===Airline Data===
The following table shows all the pages which you can include in your own VA website.
<div class="NavFrame collapsed">
{| class="wikitable"
   <div class="NavHead">Demo</div>
| Roster
| https://remote.fsairlines.net/v1/roster.php?rvi=368
|-
| Roster ( Alternate )
| https://remote.fsairlines.net/v1/roster_2.php?rvi=368
|-
| Fleet
| https://remote.fsairlines.net/v1/fleet.php?rvi=368
|-
| Fleet ( Alternate )
| https://remote.fsairlines.net/v1/fleet_2.php?rvi=368
|-
| Timetable
| https://remote.fsairlines.net/v1/timetable.php?rvi=368
|-
| Timetable ( Alternate )
| https://remote.fsairlines.net/v1/timetable_2.php?rvi=368
|-
| Flight Reports ( Pireps )
| https://remote.fsairlines.net/v1/pireps.php?rvi=368
|-
| Financial Report
| https://remote.fsairlines.net/v1/finance.php?rvi=368
|-
| Reliability Report
| https://remote.fsairlines.net/v1/reliability.php?rvi=368
|-
| Pilot Stats
| https://remote.fsairlines.net/v1/pilotstats.php?rvi=368
|-
| Monthly Pilot Stats
| https://remote.fsairlines.net/v1/mpilotstats.php?rvi=368
|-
| Fleet Stats
| https://remote.fsairlines.net/v1/fleetstats.php?rvi=368
|-
| Monthly Fleet Stats
| https://remote.fsairlines.net/v1/mfleetstats.php?rvi=368
|-
| Country Stats
| https://remote.fsairlines.net/v1/countrystats.php?rvi=368
|-
| Dispatch Office
| https://remote.fsairlines.net/v1/dispatch.php?rvi=368
|-
| Pilot Registration & Application (*)
| https://remote.fsairlines.net/v1/application.php?rvi=368
|-
| Infobox
| https://remote.fsairlines.net/v1/infobox.php?rvi=368
|-
| Infobox ( Alternate )
| https://remote.fsairlines.net/v1/infobox2.php?rvi=368
|-
| Booked Flights
| https://remote.fsairlines.net/v1/flights_booked.php?rvi=368
|-
| Active Flights
| https://remote.fsairlines.net/v1/flights_active.php?rvi=368
|-
| Active Flights ( Alternate )
| https://remote.fsairlines.net/v1/flights_active2.php?rvi=368
|-
| Last Flights
| https://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===
 
<div class="NavFrame">
  <div class="NavHead">Roster</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/roster.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Roster (Alternate)</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/roster_2.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Fleet</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/fleet.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Fleet (Alternate)</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/fleet_2.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Timetable</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/timetable.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Timetable (Alternate)</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/timetable_2.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
===Reports===
 
<div class="NavFrame">
  <div class="NavHead">Flight Reports (PIREPs)</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/pireps.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Financial Report</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/finance.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Reliability Report</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/reliability.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
===Statistics===
 
<div class="NavFrame">
  <div class="NavHead">Pilot Stats</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/pilotstats.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Monthly Pilot Stats</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/mpilotstats.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Fleet Stats</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/fleetstats.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Monthly Fleet Stats</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/mfleetstats.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Country Stats</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/countrystats.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Infobox</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/infobox.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Infobo (Alternate)</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/infobox2.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
===Interactive===
 
<div class="NavFrame">
  <div class="NavHead">Dispatch Office</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/dispatch.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Pilot Registration & Application</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/application.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
===Flights===
 
<div class="NavFrame">
   <div class="NavHead">Booked Flights</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/flights_booked.php?rvi=7&title=off</anyweb>
   </div>
   </div>
</div>
</div>


===Aircraft Data===
<div class="NavFrame">
===Pilot Data===
  <div class="NavHead">Active Flights</div>
===Flight Reports===
  <div class="NavContent">
===Other===
    <anyweb>http://remote.fsairlines.net/v1/flights_active.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Active Flights (Alternate)</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/flights_active2.php?rvi=7&title=off</anyweb>
  </div>
</div>
 
<div class="NavFrame">
  <div class="NavHead">Last Flights</div>
  <div class="NavContent">
    <anyweb>http://remote.fsairlines.net/v1/lastflights.php?rvi=7&title=off</anyweb>
  </div>
</div>

Latest revision as of 15:30, 22 June 2022

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 https://remote.fsairlines.net/v1/roster.php?rvi=368
Roster ( Alternate ) https://remote.fsairlines.net/v1/roster_2.php?rvi=368
Fleet https://remote.fsairlines.net/v1/fleet.php?rvi=368
Fleet ( Alternate ) https://remote.fsairlines.net/v1/fleet_2.php?rvi=368
Timetable https://remote.fsairlines.net/v1/timetable.php?rvi=368
Timetable ( Alternate ) https://remote.fsairlines.net/v1/timetable_2.php?rvi=368
Flight Reports ( Pireps ) https://remote.fsairlines.net/v1/pireps.php?rvi=368
Financial Report https://remote.fsairlines.net/v1/finance.php?rvi=368
Reliability Report https://remote.fsairlines.net/v1/reliability.php?rvi=368
Pilot Stats https://remote.fsairlines.net/v1/pilotstats.php?rvi=368
Monthly Pilot Stats https://remote.fsairlines.net/v1/mpilotstats.php?rvi=368
Fleet Stats https://remote.fsairlines.net/v1/fleetstats.php?rvi=368
Monthly Fleet Stats https://remote.fsairlines.net/v1/mfleetstats.php?rvi=368
Country Stats https://remote.fsairlines.net/v1/countrystats.php?rvi=368
Dispatch Office https://remote.fsairlines.net/v1/dispatch.php?rvi=368
Pilot Registration & Application (*) https://remote.fsairlines.net/v1/application.php?rvi=368
Infobox https://remote.fsairlines.net/v1/infobox.php?rvi=368
Infobox ( Alternate ) https://remote.fsairlines.net/v1/infobox2.php?rvi=368
Booked Flights https://remote.fsairlines.net/v1/flights_booked.php?rvi=368
Active Flights https://remote.fsairlines.net/v1/flights_active.php?rvi=368
Active Flights ( Alternate ) https://remote.fsairlines.net/v1/flights_active2.php?rvi=368
Last Flights https://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

Roster
   <anyweb>http://remote.fsairlines.net/v1/roster.php?rvi=7&title=off</anyweb>
Roster (Alternate)
   <anyweb>http://remote.fsairlines.net/v1/roster_2.php?rvi=7&title=off</anyweb>
Fleet
   <anyweb>http://remote.fsairlines.net/v1/fleet.php?rvi=7&title=off</anyweb>
Fleet (Alternate)
   <anyweb>http://remote.fsairlines.net/v1/fleet_2.php?rvi=7&title=off</anyweb>
Timetable
   <anyweb>http://remote.fsairlines.net/v1/timetable.php?rvi=7&title=off</anyweb>
Timetable (Alternate)
   <anyweb>http://remote.fsairlines.net/v1/timetable_2.php?rvi=7&title=off</anyweb>

Reports

Flight Reports (PIREPs)
   <anyweb>http://remote.fsairlines.net/v1/pireps.php?rvi=7&title=off</anyweb>
Financial Report
   <anyweb>http://remote.fsairlines.net/v1/finance.php?rvi=7&title=off</anyweb>
Reliability Report
   <anyweb>http://remote.fsairlines.net/v1/reliability.php?rvi=7&title=off</anyweb>

Statistics

Pilot Stats
   <anyweb>http://remote.fsairlines.net/v1/pilotstats.php?rvi=7&title=off</anyweb>
Monthly Pilot Stats
   <anyweb>http://remote.fsairlines.net/v1/mpilotstats.php?rvi=7&title=off</anyweb>
Fleet Stats
   <anyweb>http://remote.fsairlines.net/v1/fleetstats.php?rvi=7&title=off</anyweb>
Monthly Fleet Stats
   <anyweb>http://remote.fsairlines.net/v1/mfleetstats.php?rvi=7&title=off</anyweb>
Country Stats
   <anyweb>http://remote.fsairlines.net/v1/countrystats.php?rvi=7&title=off</anyweb>
Infobox
   <anyweb>http://remote.fsairlines.net/v1/infobox.php?rvi=7&title=off</anyweb>
Infobo (Alternate)
   <anyweb>http://remote.fsairlines.net/v1/infobox2.php?rvi=7&title=off</anyweb>

Interactive

Dispatch Office
   <anyweb>http://remote.fsairlines.net/v1/dispatch.php?rvi=7&title=off</anyweb>
Pilot Registration & Application
   <anyweb>http://remote.fsairlines.net/v1/application.php?rvi=7&title=off</anyweb>

Flights

Booked Flights
   <anyweb>http://remote.fsairlines.net/v1/flights_booked.php?rvi=7&title=off</anyweb>
Active Flights
   <anyweb>http://remote.fsairlines.net/v1/flights_active.php?rvi=7&title=off</anyweb>
Active Flights (Alternate)
   <anyweb>http://remote.fsairlines.net/v1/flights_active2.php?rvi=7&title=off</anyweb>
Last Flights
   <anyweb>http://remote.fsairlines.net/v1/lastflights.php?rvi=7&title=off</anyweb>
Retrieved from "https://wiki4.fsairlines.net/index.php?title=Official_FSAirlines_Integration_Pack&oldid=3302"