oebb/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

2014-01-20 18:47:15 +00:00
Dokumentation für die oebbApi
2014-01-15 11:38:54 +00:00
==========
2014-01-20 18:47:15 +00:00
Allgemeines
-----------
2014-01-20 18:49:32 +00:00
**Was brauche ich dafür?**
2014-01-20 18:47:15 +00:00
* 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/](http://code.google.com/p/phpquery/)
2014-01-20 18:49:32 +00:00
**Was müssen ich beachten?**
2014-01-20 18:47:15 +00:00
* 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.
2014-01-21 06:39:50 +00:00
* Zu jeder Funktion gibt es auch ein Beispiel. Siehe PDF.
2014-01-20 18:47:15 +00:00
* Es gelten die Allgemeinen Geschäftsbedingungen und die Nutzungsbedingungen von [oebb.at](http://oebb.at). [http://www.oebb.at/de/Nutzungsbedingungen/index.jsp](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!
2014-01-20 18:49:32 +00:00
2014-01-20 18:47:15 +00:00
Wenn Sie etwas für einen Lehrling in ersten Lehrjahr spenden möchten, dann können Sie das über diese Links tun. :)
2014-01-20 18:49:32 +00:00
2014-01-20 18:47:15 +00:00
[Flattr](https://flattr.com/profile/internetztube)
2014-01-20 18:49:32 +00:00
2014-01-20 18:47:15 +00:00
[PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TKFLMZMXM3Z64)
2014-01-20 21:18:22 +00:00
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.
2014-01-21 06:39:50 +00:00
**Useage**
| Name | Typ | Beschreibung | Zwingend benötigt |
|------|--------|------------------| ----------------- |
| name | string | Name der Station | X |
**Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt |
|------|-----|--------------| ----------------- |
| value | string | Gültiger Name der Station | X |
| id | int | Irgend eine ÖBB Stations ID | |
2014-01-20 21:18:22 +00:00
2014-01-20 18:47:15 +00:00