diff --git a/README.md b/README.md index 32af696..97fa6db 100644 --- a/README.md +++ b/README.md @@ -39,15 +39,15 @@ Station validieren - validate() **Useage** | Name | Typ | Beschreibung | Zwingend benötigt | -| ---- | ------ | ---------------- | ----------------- | -| name | string | Name der Station | X | +| ---- | ------ | ---------------- | ----------------: | +| name | string | Name der Station | Ja | **Rückgabewerte** | 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 | Ja | +| id | int | Irgend eine ÖBB Stations ID | Nein | Verbindung suchen - get() @@ -62,29 +62,29 @@ Verbindung suchen - get() **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 | +| --------- | ------ | ------------------------ | ----------------: | +| 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 | | -| 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. | | +| ------------ | ------ | --------------------------------------------- | ------------: | +| 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 | @@ -100,8 +100,8 @@ Details einer Verbindung - getDetails **Useage** | Name | Typ | Beschreibung | Zwingend benötigt | -| ---- | --- | -------------------------------------------- | ----------------- | -| id | int | Index der spezifischen Verbindung. Siehe get | X | +| ---- | --- | -------------------------------------------- | ----------------: | +| id | int | Index der spezifischen Verbindung. Siehe get | Ja |