mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-04-20 23:23:56 +03:00
docs
This commit is contained in:
parent
bcaad526c7
commit
f741a13670
3 changed files with 31 additions and 5 deletions
|
@ -75,7 +75,9 @@ With `opt`, you can override the default options, which look like this:
|
||||||
subStops: true, // not supported
|
subStops: true, // not supported
|
||||||
entrances: true, // not supported
|
entrances: true, // not supported
|
||||||
remarks: true, // parse & expose hints & warnings?
|
remarks: true, // parse & expose hints & warnings?
|
||||||
scheduledDays: false, // not yet supported
|
scheduledDays: false, // returns a field `serviceDays` (instead of `scheduledDays` in hafas-client!) with a different, human-readable structure
|
||||||
|
notOnlyFastRoutes: false, // if true, also show journeys that are mathematically non-optimal
|
||||||
|
bestprice: false, // search for lowest prices across the entire day, returns list of journeys sorted by price
|
||||||
firstClass: false, // first or second class for tickets
|
firstClass: false, // first or second class for tickets
|
||||||
loyaltyCard: null, // BahnCards etc., see below
|
loyaltyCard: null, // BahnCards etc., see below
|
||||||
language: 'en', // language to get results in
|
language: 'en', // language to get results in
|
||||||
|
|
|
@ -365,7 +365,19 @@ paths:
|
||||||
default: true
|
default: true
|
||||||
- name: scheduledDays
|
- name: scheduledDays
|
||||||
in: query
|
in: query
|
||||||
description: Parse & return dates each journey is valid on?
|
description: Parse & return dates the journey is valid on?, returns a field `serviceDays` (instead of `scheduledDays` in hafas-client!) with a different, human-readable structure
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
- name: notOnlyFastRoutes
|
||||||
|
in: query
|
||||||
|
description: if true, also show journeys that are mathematically non-optimal
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
- name: bestprice
|
||||||
|
in: query
|
||||||
|
description: search for lowest prices across the entire day
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
|
@ -683,7 +695,19 @@ paths:
|
||||||
default: true
|
default: true
|
||||||
- name: scheduledDays
|
- name: scheduledDays
|
||||||
in: query
|
in: query
|
||||||
description: Parse & return dates the journey is valid on?
|
description: Parse & return dates the journey is valid on?, returns a field `serviceDays` (instead of `scheduledDays` in hafas-client!) with a different, human-readable structure
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
- name: notOnlyFastRoutes
|
||||||
|
in: query
|
||||||
|
description: if true, also show journeys that are mathematically non-optimal
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
- name: bestprice
|
||||||
|
in: query
|
||||||
|
description: search for lowest prices across the entire day
|
||||||
schema:
|
schema:
|
||||||
type: boolean
|
type: boolean
|
||||||
default: false
|
default: false
|
||||||
|
|
|
@ -8,14 +8,14 @@
|
||||||
|
|
||||||
This is an early version. What works:
|
This is an early version. What works:
|
||||||
|
|
||||||
* `journeys()`, `refreshJourney()` including tickets
|
* `journeys()`, `refreshJourney()` including tickets and bestprice option
|
||||||
* `locations()`, `nearby()`,
|
* `locations()`, `nearby()`,
|
||||||
* `departures()`, `arrivals()` boards
|
* `departures()`, `arrivals()` boards
|
||||||
* `trip()`
|
* `trip()`
|
||||||
|
|
||||||
What doesn't work:
|
What doesn't work:
|
||||||
|
|
||||||
* `journeys()` details like scheduledDays, stop/station groups, some line details ...
|
* `journeys()` details like stop/station groups, some line details ...
|
||||||
* loadFactor and other details in boards
|
* loadFactor and other details in boards
|
||||||
* certain stop details like products for `locations()` and geopositions for boards – this can be remedied with `enrichStations` in the config (turned on by default), enriching stop info with [db-hafas-stations](https://github.com/derhuerst/db-hafas-stations).
|
* certain stop details like products for `locations()` and geopositions for boards – this can be remedied with `enrichStations` in the config (turned on by default), enriching stop info with [db-hafas-stations](https://github.com/derhuerst/db-hafas-stations).
|
||||||
* some query options/filters (e.g. routingMode for journeys, direction for boards)
|
* some query options/filters (e.g. routingMode for journeys, direction for boards)
|
||||||
|
|
Loading…
Add table
Reference in a new issue