Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] manage park and ride #4359

Merged
merged 2 commits into from
Mar 25, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions documentation/slate/source/includes/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -997,21 +997,22 @@ See how disruptions affect a journey in the [real time](#realtime) section.
| nop | walking_speed | float | Walking speed for the fallback sections<br>Speed unit must be in meter/seconds | 1.12 m/s<br>(4 km/h)<br>*Yes, man, they got the metric system* |
| nop | bike_speed | float | Biking speed for the fallback<br>Speed unit must be in meter/seconds | 4.1 m/s<br>(14.7 km/h) |
| nop | bss_speed | float | Speed while using a bike from a bike sharing system for the fallback sections<br>Speed unit must be in meter/seconds | 4.1 m/s<br>(14.7 km/h) |
| nop | car_speed | float | Driving speed for the fallback sections<br>Speed unit must be in meter/seconds | 16.8 m/s<br>(60 km/h) |
| nop | min_nb_journeys | non-negative int | Minimum number of different suggested journeys<br>More in multiple_journeys | |
| nop | max_nb_journeys | positive int | Maximum number of different suggested journeys<br>More in multiple_journeys | |
| nop | count | int | Fixed number of different journeys<br>More in multiple_journeys | |
| nop | max_nb_transfers | int | Maximum number of transfers in each journey | 10 |
| nop | max_nb_transfers | int | Maximum number of transfers in each journey | 10 |
| nop | min_nb_transfers | int | Minimum number of transfers in each journey | 0 |
| nop | max_duration | int | If `datetime` represents the departure of the journeys requested, then the last public transport section of all journeys will end before `datetime` + `max_duration`.<br>If `datetime` represents the arrival of the journeys requested, then the first public transport section of all journeys will start after `datetime` - `max_duration`.<br>More useful when computing an isochrone (only `from` or `to` is provided)<br>Unit is seconds | 86400 |
| nop | wheelchair | boolean | If true the traveler is considered to be using a wheelchair, thus only accessible public transport are used<br>be warned: many data are currently too faint to provide acceptable answers with this parameter on | False |
| nop | wheelchair | boolean | If true the traveler is considered to be using a wheelchair, thus only accessible public transport are used<br>You should prefer using the parameter `&traveler_type=wheelchair` which adjusts many other parameters (speed, walkways, etc.)<br>Be warned: many data are currently too faint to provide acceptable answers with this parameter on. | False |
| nop | direct_path | enum | Specify if Navitia should suggest direct paths (= only fallback modes are used).<br>Possible values: <ul><li>`indifferent`</li><li>`none` for only journeys using some PT</li><li>`only` for only journeys without PT</li><li>`only_with_alternatives` for different journey alternatives without PT</li> </ul> | indifferent |
| nop | direct_path_mode[] | array of strings | Force direct-path modes. If this list is not empty, we only compute direct_path for modes in this list and filter all the direct_paths of modes in first_section_mode[]. It can take the following values: `walking`, `car`, `bike`, `bss`, `ridesharing`, `taxi`. It's an array, you can give multiple modes. If this list is empty, we will compute direct_path for modes of the first_section_modes. | first_section_modes[] |
| nop | direct_path_mode[] | array of strings | Force direct-path modes. If this list is not empty, we only compute direct_path for modes in this list and filter all the direct_paths of modes in first_section_mode[]. It can take the following values: `walking`, `car`, `bike`, `bss`, `ridesharing`, `taxi`. It's an array, you can give multiple modes. If this list is empty, we will compute direct_path for modes of the first_section_modes. | first_section_modes[] |
| nop | add_poi_infos[] | boolean | Activate the output of additional infomations about the poi. For example, parking availability(BSS, car parking etc.) in the pois of response. Possible values are `bss_stands`, `car_park` | []
| nop | debug | boolean | Debug mode<br>No journeys are filtered in this mode | False |
| nop | free_radius_from | int | Radius length (in meters) around the coordinates of departure in which the stop points are considered free to go (crowfly=0) | 0 |
| nop | free_radius_to | int | Radius length (in meters) around the coordinates of arrival in which the stop points are considered free to go (crowfly=0) | 0 |
| nop | timeframe_duration | int | Minimum timeframe to search journeys (in seconds, maximum allowed value = 86400). For example 'timeframe_duration=3600' will search for all interesting journeys departing within the next hour. | 0 |
| nop | free_radius_to | int | Radius length (in meters) around the coordinates of arrival in which the stop points are considered free to go (crowfly=0) | 0 |
| nop | timeframe_duration | int | Minimum timeframe to search journeys (in seconds, maximum allowed value = 86400). For example 'timeframe_duration=3600' will search for all interesting journeys departing within the next hour. | 0 |
| nop | park_mode | enum | Method to prk your bike before taking public transport. Value between <ul><li>`none`</li><li>`on_street`</li><li>`park_and_ride`</li> </ul> When using `on_street`, Navitia will add a "park" section (to hang your bike), and a "walk" section to reach the next stop_point via the access_point | none |


### Precisions on `forbidden_uris[]` and `allowed_id[]`

Expand Down Expand Up @@ -1115,7 +1116,7 @@ Here is a typical journey, all sections are detailed below

Field | Type | Description
-------------------------|-----------------------------------------------|------------
type | *enum* string | Type of the section.<ul><li>`public_transport`: public transport section</li><li>`street_network`: street section</li><li>`waiting`: waiting section between transport</li><li><p>`stay_in`: this “stay in the vehicle” section occurs when the traveller has to stay in the vehicle when the bus change its routing. Here is an exemple for a journey from A to B: (lollipop line)</p><p>![image](stay_in.png)</p></li><li>`transfer`: transfert section</li><li><p>`crow_fly`: teleportation section, most of the time. Useful to make navitia idempotent when starting from or arriving to a city or a stop_area (“potato shaped” objects) in order to route to the nearest stop_point. Be careful: neither “path” nor “geojson” available in a crow_fly section.</p><p> Can also be used when no street_network data are available and not be considered as teleportation. The distance of such a crow_fly section will be a straight line between the point of departure and arrival (hence the name 'crow_fly'). The duration of the section will be calculated with the Manhattan distance of the section (distance x √2). In this case, “geojson” is available.</p><p>![image](crow_fly.png)</p></li><li>`on_demand_transport`: vehicle may not drive along: traveler will have to call agency to confirm journey</li><li>`bss_rent`: taking a bike from a bike sharing system (bss)</li><li>`bss_put_back`: putting back a bike from a bike sharing system (bss)</li><li>`boarding`: boarding on vehicle (boat, on-demand-transport, plane, ...)</li><li>`alighting`: getting off a vehicle</li><li>`park`: parking a car</li><li>`ridesharing`: car-pooling section</li></ul>
type | *enum* string | Type of the section.<ul><li>`public_transport`: public transport section</li><li>`street_network`: street section</li><li>`waiting`: waiting section between transport</li><li><p>`stay_in`: this “stay in the vehicle” section occurs when the traveller has to stay in the vehicle when the bus change its routing. Here is an exemple for a journey from A to B: (lollipop line)</p><p>![image](stay_in.png)</p></li><li>`transfer`: transfert section</li><li><p>`crow_fly`: teleportation section, most of the time. Useful to make navitia idempotent when starting from or arriving to a city or a stop_area (“potato shaped” objects) in order to route to the nearest stop_point. Be careful: neither “path” nor “geojson” available in a crow_fly section.</p><p> Can also be used when no street_network data are available and not be considered as teleportation. The distance of such a crow_fly section will be a straight line between the point of departure and arrival (hence the name 'crow_fly'). The duration of the section will be calculated with the Manhattan distance of the section (distance x √2). In this case, “geojson” is available.</p><p>![image](crow_fly.png)</p></li><li>`on_demand_transport`: vehicle may not drive along: traveler will have to call agency to confirm journey</li><li>`bss_rent`: taking a bike from a bike sharing system (bss)</li><li>`bss_put_back`: putting back a bike from a bike sharing system (bss)</li><li>`boarding`: boarding on vehicle (boat, on-demand-transport, plane, ...)</li><li>`alighting`: getting off a vehicle</li><li>`park`: parking a bike or your personnal car</li><li>`ridesharing`: car-pooling section</li></ul>
id | string | Id of the section
mode | *enum* string | Mode of the street network and crow_fly: `Walking`, `Bike`, `Car`, 'Taxi'
duration | int | Duration of this section
Expand Down
Loading