From 4b95545392a4a1d2d8446b54fb9bd24c1ca7a178 Mon Sep 17 00:00:00 2001 From: Fred Date: Tue, 21 Jan 2014 08:30:35 +0100 Subject: [PATCH] Update --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99450a0..5583a43 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,8 @@ Wenn Sie etwas für einen Lehrling in ersten Lehrjahr spenden möchten, dann kö [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TKFLMZMXM3Z64) -Station validieren - validate + +Station validieren - validate() ----------- **Wissenwertes** @@ -44,7 +45,62 @@ Station validieren - validate | Name | Typ | Beschreibung | Wird benötigt | |------|-----|--------------| ----------------- | | value | string | Gültiger Name der Station | X | -| id | int | Irgend eine ÖBB Stations ID | | +| id | int | Irgend eine ÖBB Stations ID | | + + +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. + +**Useage** +| Name | Typ | Beschreibung | Zwingend benötigt | +|------|--------|------------------| ----------------- | +| departure | string | Name der Abfahrtsstation | X | +| arrival | string | Name der Ankunftsstation | X | +| amount | int | Anzahl der Verbindungen | X | + +**Rückgabewerte** +| Name | Typ | Beschreibung | Wird benötigt | +|------|-----|--------------| ----------------- | +| startStation | string | Name der Abfahrtsstation | | +| endStation | string | Name der Ankunftsstation | | +| startDate | string | Abfahrtsdatum, wichtig bei Nachtzügen | | +| endDate | string | Ankunftsdatum | | +| startTime | string | Abfahrtszeit | | +| endTime | string | Ankunftszeit | | +| duration | string | Fahrtdauer | | +| changes | int | Umstiege | | +| buyLink | string | Kauflink zur Verbindung | | +| changesLink | string | Link zur Verbindung auf oebb.at | | +| products | array | Alle Verkehrsmittel mit Bezeichnung und Bild | | +| prognose | string | BETA, Verspätungen + | | +| id | int | Nummer der Verbindung der Anfrage + | | +| earlier | string | Siehe oben. | | + + + +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). + +**Useage** +| Name | Typ | Beschreibung | Zwingend benötigt | +|------|--------|------------------| ----------------- | +| id | int | Index der spezifischen Verbindung. Siehe get | X | + +