Docstring added
This commit is contained in:
parent
c08deb9ff2
commit
9da83c878e
@ -21,7 +21,27 @@ def journey_detail(
|
||||
from_index: int = None,
|
||||
to_id: str = None,
|
||||
to_index: int = None
|
||||
):
|
||||
) -> Journey:
|
||||
"""The journey_detail method will deliver information about the complete route of a vehicle. The journey
|
||||
identifier is part of a trip or `board_departure` response. It contains a list of all stops/stations of this journey
|
||||
including all departure and arrival times (with real-time data if available) and additional information like
|
||||
specific attributes about facilities and other texts.
|
||||
|
||||
More detailed request is available as `raw.journey_detail()`, however returns `dict` instead of `Journey`.
|
||||
|
||||
### Args:
|
||||
* access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html).
|
||||
* id (`str`): Specifies the internal journey id of the journey shall be retrieved. Maximum length 512.
|
||||
* date (`Union[str, datetime]`, **optional**): Day of operation. Represented in the format `YYYY-MM-DD` or as a datetime object. By default the current server date is used. Defaults to `None`.
|
||||
* real_time_mode (`Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT]`, **optional**): Set the realtime mode to be used. Read more about this in HAFAS ReST Documentation. Defaults to `None`.
|
||||
* from_id (`str`, **optional**): Specifies the station/stop ID the partial itinerary shall start from. Defaults to `None`.
|
||||
* from_index (`int`, **optional**): Specifies the station/stop index the partial itinerary shall start from. Defaults to `None`.
|
||||
* to_id (`str`, **optional**): Specifies the station/stop ID the partial itinerary shall end at. Defaults to `None`.
|
||||
* to_index (`int`, **optional**): Specifies the station/stop index the partial itinerary shall end at. Defaults to `None`.
|
||||
|
||||
### Returns:
|
||||
* Journey: Instance of Journey object.
|
||||
"""
|
||||
|
||||
journey_raw = raw_journey_detail(
|
||||
accessId=access_id,
|
||||
|
Loading…
Reference in New Issue
Block a user