Skip to content

Commit

Permalink
Include avoidId in parameter table for resrobot route planner
Browse files Browse the repository at this point in the history
  • Loading branch information
Bertware committed Jan 7, 2025
1 parent 91724c6 commit 3181d82
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion content/api/trafiklab-apis/resrobot-v21/route-planner.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,13 @@ https://api.resrobot.se/v2.1/trip?format=xml&originId=740000001&destId=740000003
| destId | String | Either destId or destCoordLat+destCoordLong are required | Stop id to search a route to. Can be obtained from the Stop lookup API, Nearby stops API, or GTFS Sverige 2 |
| destCoordLat, destCoordLong | String | Either destId or destCoordLat+destCoordLong are required | Coordinates of the destination. ResRobot will calculate walking legs if needed<br>Latitude (WGS84, decimal degree), ex 59.330150<br>Longitude (WGS84, decimal degree), ex 18.056618 |
| viaId | String | No, default no via | Id of an additional stop that should be passed on the way. |
| avoidId | String | No, default no stations to avoid | Id of a stop that should be avoided for transfers. |
| numF | Integer (1-6) | No, default 5 | Number of results to fetch, departing after the specified date/time. The sum of numF and numB should not be more than 6. Ignored when searchForArrival is set to 1. |
| numB | Integer (0-5) | No, default 0 | Number of results to fetch, departing before the specified date/time. The sum of numF and numB should not be more than 6. Ignored when searchForArrival is set to 1. |
| context | String | Np, default unspecified | Reference for scrolling further up or down from a previous search result. |
| maxChange | Integer (1-3) | No, default unlimited | Limits the maximum number of transfers. |
| products | Integer | No, default all products | Only include certain traffic modes, see [common request products](common.md) |
| operators | comma seperated integers | No, default all operators | Only include traffic from specified operators. Operators are specified by their id, which can be obtained from GTFS Sverige 2<br>Example: operators=275,287<br>(275=SL, 287=Arlanda Express) |
| operators | comma seperated integers | No, default all operators | Only include traffic from specified operators. Operators are specified by their id, which can be obtained from GTFS Sverige 2. Start a value with an exclamation mark '!' to exclude an operator.<br>Example: operators=275,287 to only allow these two operators, or operators=!275,!287 to avoid these two operators<br>(275=SL, 287=Arlanda Express) |
| passlist | Integer | No, default 0 | Set to 1 to include a list of the stops which are passed on the route of a vehicle. 0 to leave the list out of the result. |
| originWalk | comma separated integers | No | 4 comma separated values: `allow walks`,`minimum walking distance`,`maximum walking distance`,`walking time in %`<br>`allow walks`: Set to `1` to allow walks to the first stop. Set to `0` to disable this.<br>`minimum walking distance`,`maximum walking distance`: Minimum and maximum distance in meters, between 0 and 10000.<br>`walking time in %`: walking time, relative to the default walking speed of 5km/h + 2 minutes to orient. Between 50 and 150%. 150% means walking will take 50% longer than default.<br>Walking between 0 and 1000 meters, at 75% of the normal speed look like this: `originWalk=1,0,1000,75`. To disable walking, `originWalk=0` suffices. |
| destWalk | comma separated integers | No | 4 comma separated values: `allow walks`,`minimum walking distance`,`maximum walking distance`,`walking time in %`<br>`allow walks`: Set to `1` to allow walks from the last stop to the destination. Set to `0` to disable this.<br>`minimum walking distance`,`maximum walking distance`: Minimum and maximum distance in meters, between 0 and 10000.<br>`walking time in %`: walking time, relative to the default walking speed of 5km/h + 2 minutes to orient. Between 50 and 150%. 150% means walking will take 50% longer than default.<br>Walking between 0 and 1000 meters, at 75% of the normal speed look like this: `destwalk=1,0,1000,75`. To disable walking, `destwalk=0` suffices. |
Expand Down

0 comments on commit 3181d82

Please sign in to comment.