kumi/oebb
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update

Browse source
This commit is contained in:
Fred 2014-01-21 08:47:33 +01:00
parent 637a41163e
commit 59964add4a
1 changed files with 31 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -37,15 +37,17 @@ Station validieren - validate()
2. Für den weiteren Vorgang wird ausschließlich der name („value“) benötigt. 2. Für den weiteren Vorgang wird ausschließlich der name („value“) benötigt.
**Useage** **Useage**
| Name | Typ | Beschreibung | Zwingend benötigt |
|------|--------|------------------| ----------------- | | Name | Typ | Beschreibung | Zwingend benötigt |
| name | string | Name der Station | X | | ---- | ------ | ---------------- | ----------------- |
| name | string | Name der Station | X |
**Rückgabewerte** **Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt |
|------|-----|--------------| ----------------- | | Name | Typ | Beschreibung | Wird benötigt |
| value | string | Gültiger Name der Station | X | | ----- | ------ | --------------------------- | ------------- |
| id | int | Irgend eine ÖBB Stations ID | | | value | string | Gültiger Name der Station | X |
| id | int | Irgend eine ÖBB Stations ID | |
Verbindung suchen - get() Verbindung suchen - get()
@ -58,6 +60,7 @@ Verbindung suchen - get()
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. 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** **Useage**
| Name | Typ | Beschreibung | Zwingend benötigt | | Name | Typ | Beschreibung | Zwingend benötigt |
| --------- | ------ | ------------------------ | ----------------- | | --------- | ------ | ------------------------ | ----------------- |
| departure | string | Name der Abfahrtsstation | X | | departure | string | Name der Abfahrtsstation | X |
@ -65,24 +68,23 @@ Verbindung suchen - get()
| amount | int | Anzahl der Verbindungen | X | | amount | int | Anzahl der Verbindungen | X |
**Rückgabewerte** **Rückgabewerte**
| Name | Typ | Beschreibung | Wird benötigt |
|--------------|-----|--------------| ----------------- | | Name | Typ | Beschreibung | Wird benötigt |
| startStation | string | Name der Abfahrtsstation | | | ------------ | ------ | --------------------------------------------- | ------------- |
| endStation | string | Name der Ankunftsstation | | | startStation | string | Name der Abfahrtsstation | |
| startDate | string | Abfahrtsdatum, wichtig bei Nachtzügen | | | endStation | string | Name der Ankunftsstation | |
| endDate | string | Ankunftsdatum | | | startDate | string | Abfahrtsdatum, wichtig bei Nachtzügen | |
| startTime | string | Abfahrtszeit | | | endDate | string | Ankunftsdatum | |
| endTime | string | Ankunftszeit | | | startTime | string | Abfahrtszeit | |
| duration | string | Fahrtdauer | | | endTime | string | Ankunftszeit | |
| changes | int | Umstiege | | | duration | string | Fahrtdauer | |
| buyLink | string | Kauflink zur Verbindung | | | changes | int | Umstiege | |
| changesLink | string | Link zur Verbindung auf oebb.at | | | buyLink | string | Kauflink zur Verbindung | |
| products | array | Alle Verkehrsmittel mit Bezeichnung und Bild | | | changesLink | string | Link zur Verbindung auf oebb.at | |
| prognose | string | BETA, Verspätungen | products | array | Alle Verkehrsmittel mit Bezeichnung und Bild | |
| | | prognose | string | BETA, Verspätungen | |
| id | int | Nummer der Verbindung der Anfrage | id | int | Nummer der Verbindung der Anfrage | |
| | | earlier | string | Siehe oben. | |
| earlier | string | Siehe oben. | |
@ -96,9 +98,10 @@ Details einer Verbindung - getDetails
3. Funktioniert nur bei einer erfolgreich ausgeführten Suche (get). 3. Funktioniert nur bei einer erfolgreich ausgeführten Suche (get).
**Useage** **Useage**
| Name | Typ | Beschreibung | Zwingend benötigt |
|------|--------|------------------| ----------------- | | Name | Typ | Beschreibung | Zwingend benötigt |
| id | int | Index der spezifischen Verbindung. Siehe get | X | | ---- | --- | -------------------------------------------- | ----------------- |
| id | int | Index der spezifischen Verbindung. Siehe get | X |