oebb/README.md

Dokumentation für die oebbApi

Allgemeines

Was brauche ich dafür?

• Einen Server, der die PHP-Files ausführen kann. Es genügt auch ein Freehoster.
• PhpQuery in der Version 0.9.5 oder höher. http://code.google.com/p/phpquery/

Was müssen ich beachten?

• Der Code bzw. die API ist nicht von einem Profi, sondern von einem Lehrling im ersten Lehrjahr programmiert worden. Deswegen bitte ich um ausschließlich konstruktive Kritik.
• Zu jeder Funktion gibt es auch ein Beispiel. Siehe PDF.
• Es gelten die Allgemeinen Geschäftsbedingungen und die Nutzungsbedingungen von oebb.at. http://www.oebb.at/de/Nutzungsbedingungen/index.jsp
• Es wird keine Haftung übernommen! Sie sind für ihr Handeln selbst verantwortlich. Der Rechtsweg ist ausgeschlossen!

Wenn Sie etwas für einen Lehrling in ersten Lehrjahr spenden möchten, dann können Sie das über diese Links tun. :)

FlattrPayPal

Station validieren - validate()

Wissenwertes

1. Es ist zu beachten, dass bei einem Aufruf mehrere Stationen zurückkommen können.
2. Für den weiteren Vorgang wird ausschließlich der name („value“) benötigt.

Parameter

Name	Typ	Beschreibung	Zwingend benötigt
name	string	Name der Station	Ja

Rückgabewerte

Name	Typ	Beschreibung	Wird benötigt
value	string	Gültiger Name der Station	Ja
id	int	Irgend eine ÖBB Stations ID	Nein

Verbindung suchen - get()

Wissenwertes

1. Die Stations-Namen können leicht abgeändert eigegeben werden. Aus „St. Pölten“ wird „St.Pölten Hbf“
2. Wenn die Parameter „date“, „time“ nicht verwendet oder mit NULL angegeben werden, wird automatisch das aktuelle Datum bzw. Zeit verwendet.
3. Die „id“ ist für die Verwendung der Funktionen „getDetails“ und in Folge „getCoords“ essenziell.
4. Wenn Sie drei Verbindungen in der Vergangenheit (relativ zur ersten Verbindung) möchten, dann verwenden Sie „earlier“ als Anfangszeit und fügen Sie zu „amount“ drei dazu.
Wenn Sie drei Verbindungen weiter in der Zukunft möchten, dann lassen die Anfangszeit gleich und erhöhen Sie einfach „amount“ um 3.

Parameter

Name	Typ	Beschreibung	Zwingend benötigt
departure	string	Name der Abfahrtsstation	Ja
arrival	string	Name der Ankunftsstation	Ja
amount	int	Anzahl der Verbindungen	Ja

Rückgabewerte

Name	Typ	Beschreibung	Wird benötigt
startStation	string	Name der Abfahrtsstation	Nein
endStation	string	Name der Ankunftsstation	Nein
startDate	string	Abfahrtsdatum, wichtig bei Nachtzügen	Nein
endDate	string	Ankunftsdatum	Nein
startTime	string	Abfahrtszeit	Nein
endTime	string	Ankunftszeit	Nein
duration	string	Fahrtdauer	Nein
changes	int	Umstiege	Nein
buyLink	string	Kauflink zur Verbindung	Nein
changesLink	string	Link zur Verbindung auf oebb.at	Nein
products	array	Alle Verkehrsmittel mit Bezeichnung und Bild	Nein
prognose	string	BETA, Verspätungen	Nein
id	int	Nummer der Verbindung der Anfrage	Nein
earlier	string	Siehe oben.	Nein

Details einer Verbindung - getDetails

Wissenwertes

1. Von der Funktion „getDetails“ bekommen Sie die essenziellen Infos einer spezifischen Verbindung.
2. Für den Aufruf benötigen Sie lediglich die „id“ der Verbindung. Diese „id“ bekommen Sie von der Funktion „get“ zurück.
3. Funktioniert nur bei einer erfolgreich ausgeführten Suche (get).

Parameter

Name	Typ	Beschreibung	Zwingend benötigt
id	int	Index der spezifischen Verbindung. Siehe get	Ja

Array	Name	Typ	Beschreibung	Wird benötigt
start
	station
	time
	plattform
	date
	prognose
end
	station
	time
	plattform
	date
	prognose
start
station (string) Name der Einstiegs Station
time (string) Abfahrtszeit von der Station
plattform (string) Bahnsteig an der Station
date (string) Abfahrtsdatum
prognose (string) Aktuelle Zeit, if n.a = string(0)
end
station (string) Name der Ausstiegs Station
time (string) Ankunftszeit an der Station
plattform (string) Bahnsteig an der Station
date (string) Ankunftsdatum
prognose (string) Aktuelle Zeit, if n.a = string(0)
data
productName (string) Produktname, z.B RJ, ICE, BUS
productImg (string) Dazugehöriges Bild zum Produkt oebb.at
productUrl (string) Übersicht für die Linie. NULL Bug
duration (string) Fahrzeit der Verbindung