{"note":"OpenAPI conversion -- returning structured metadata","name":"gov-bc-ca-router","description":"BC Route Planner REST API","version":"2.0.0","base_url":"https://router.api.gov.bc.ca/","endpoints":22,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api BC Route Planner REST API\n@base https://router.api.gov.bc.ca/\n@version 2.0.0\n@auth ApiKey apikey in header\n@common_fields {outputFormat: str(json/kml/html)=json # Format of representation, outputSRS: int(4326/4269/3005/26907/26908/26909/26910/26911)=4326 # The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS, criteria: str(shortest/fastest)=fastest # Routing criteria to optimize (e.g., shortest, fastest). Default is fastest., distanceUnit: str(km/mi)=km # distance unit of measure (e.g., km, mi). Default is km., correctSide: bool=false # If true, route starts and ends on same side of road as start and end points.Default is false., departure: str(date-time) # departure date and time in internet timestamp notation as defined in RFC 3339, section 5.6 (e.g., 2019-02-28T11:36:00-08:00); Ignored if time-dependency modules are disabled, enable: str=gdf,tr,xc,tc # A comma-separated list of modules to enable. Enable takes precedence over disable. When the enable parameter is used, unlisted values will be disabled.Module names include: sc – ferry schedules; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabled by default; disabling this disables sc, tf, and ev modulestr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns); enabled by defaultxc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by defaultgdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default, disable: str=td,ev,sc,tf # A comma-separated list of modules to disable. Enable takes precedence over disable. When the disable parameter is used, unlisted values will be enabled.Module names include: sc – ferry schedules; disabled by default and only suitable for demostf – historic traffic congestion; disabled by default and only suitable for demosev – road events; disabled by default and only suitable for demostd – time-dependency; disabled by default; disabling this disables sc, tf, and ev modulestr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignoredtc - turn costs (e.g., left turns take longer than right turns); enabled by defaultxc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by defaultgdf - global distortion field; applies friction factors to road segments by ITN road class; this makes major roads more attractive than minor ones; enabled by default, snapDistance: int=1000 # To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters., minRoutingDistance: int=0 # The minimum routing distance (in metres) that must exist between points to calculate a route. The default value is 0., routeDescription: str=Routing results # Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)}\n@endpoints 22\n@hint download_for_search\n@toc distance.{outputFormat}(2), distance(2), route.{outputFormat}(2), directions.{outputFormat}(2), optimalRoute.{outputFormat}(2), optimalDirections.{outputFormat}(2), truck(10)\n\n@group distance.{outputFormat}\n@endpoint GET /distance.{outputFormat}\n@desc Get distance and travel time between two geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false.}\n@returns(200) Distance and time of the shortest or fastest route\n\n@endpoint POST /distance.{outputFormat}\n@desc Get distance and travel time between two geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false.}\n@returns(200) Distance and time of the shortest or fastest route\n\n@endgroup\n\n@group distance\n@endpoint GET /distance/betweenPairs.{outputFormat}\n@desc Get distance and travel time between each pair of geographic points\n@required {fromPoints: str # A comma-separated list of origin points.  See fromPoints, toPoints: str # A comma-separated list of destination points. See toPoints}\n@optional {maxPairs: int=1 # The maximum number of pairs to return for each toPoint.  Pairs are ordered by distance/time from fromPoint. For example, given 1 fromPoint, and 10 toPoints, and maxPairs=1 , return the nearest toPoint to the fromPoint. Given 3 fromPoints and 10 toPoints, maxPairs=3 means return the 3 nearest toPoints to each fromPoint.}\n@returns(200) A list of routes and their route distances/times.\n\n@endpoint POST /distance/betweenPairs.{outputFormat}\n@desc Get distance and travel time between each pair of geographic points\n@required {fromPoints: str # A comma-separated list of origin points.  See fromPoints, toPoints: str # A comma-separated list of destination points. See toPoints}\n@optional {maxPairs: int=1 # The maximum number of pairs to return for each toPoint.  Pairs are ordered by distance/time from fromPoint. For example, given 1 fromPoint, and 10 toPoints, and maxPairs=1 , return the nearest toPoint to the fromPoint. Given 3 fromPoints and 10 toPoints, maxPairs=3 means return the 3 nearest toPoints to each fromPoint.}\n@returns(200) A list of routes and their route distances/times.\n\n@endgroup\n\n@group route.{outputFormat}\n@endpoint GET /route.{outputFormat}\n@desc Get the path, distance and travel time between a series of geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false.}\n@returns(200) Geometry, distance, and time of the shortest or fastest route\n\n@endpoint POST /route.{outputFormat}\n@desc Get the path, distance and travel time between a series of geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false.}\n@returns(200) Geometry, distance, and time of the shortest or fastest route\n\n@endgroup\n\n@group directions.{outputFormat}\n@endpoint GET /directions.{outputFormat}\n@desc Get the directions, path, distance and travel time between a series of geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored.}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route\n\n@endpoint POST /directions.{outputFormat}\n@desc Get the directions, path, distance and travel time between a series of geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored.}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route\n\n@endgroup\n\n@group optimalRoute.{outputFormat}\n@endpoint GET /optimalRoute.{outputFormat}\n@desc Get the optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false.}\n@returns(200) Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time\n\n@endpoint POST /optimalRoute.{outputFormat}\n@desc Get the path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false.}\n@returns(200) Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time.\n\n@endgroup\n\n@group optimalDirections.{outputFormat}\n@endpoint GET /optimalDirections.{outputFormat}\n@desc Get the directions, optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored.}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time.\n\n@endpoint POST /optimalDirections.{outputFormat}\n@desc Get the directions, optimal path, distance and travel time between a start point and one or more end points which are reordered to minimize total distance or time.\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored.}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time.\n\n@endgroup\n\n@group truck\n@endpoint GET /truck/distance.{outputFormat}\n@desc Get distance and travel time between two geographic points for a commercial vehicle\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) Distance and time of the shortest or fastest route\n\n@endpoint POST /truck/distance.{outputFormat}\n@desc Get distance and travel time between two geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) Distance and time of the shortest or fastest route\n\n@endpoint GET /truck/route.{outputFormat}\n@desc Get the path, distance and travel time between a series of geographic points for a commercial vehicle\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) Geometry, distance, and time of the shortest or fastest route\n\n@endpoint POST /truck/route.{outputFormat}\n@desc Get the path, distance and travel time between a series of geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) Geometry, distance, and time of the shortest or fastest route\n\n@endpoint GET /truck/directions.{outputFormat}\n@desc Get the directions, path, distance and travel time between a series of geographic points for a commercial vehicle\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored., listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route\n\n@endpoint POST /truck/directions.{outputFormat}\n@desc Get the directions, path, distance and travel time between a series of geographic points\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored., listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route\n\n@endpoint GET /truck/optimalRoute.{outputFormat}\n@desc Get the optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time for a commercial vehicle\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time\n\n@endpoint POST /truck/optimalRoute.{outputFormat}\n@desc Get the path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time.\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) Geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time.\n\n@endpoint GET /truck/optimalDirections.{outputFormat}\n@desc Get the directions, optimal path, distance and travel time between a start point and a series of end points which are reordered to minimize total distance or time for a commercial vehicle\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored., listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time.\n\n@endpoint POST /truck/optimalDirections.{outputFormat}\n@desc Get the directions, optimal path, distance and travel time between a start point and one or more end points which are reordered to minimize total distance or time.\n@required {points: str # A list of any number of route points in start to end order. See points}\n@optional {roundTrip: bool=false # If true, route ends at start point. Default is false., truckRouteMultiplier: int=9 # The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes., height: num=null # The height of the truck in metres (**only suitable for demos**)., width: num=null # The width of the truck in metres (**only suitable for demos**)., length: num=null # The length of the truck in metres (**only suitable for demos**)., weight: num=null # The weight of the truck in kilograms (**only suitable for demos**)., partition: str= # A comma-separated list of values to identify sections of the route that correspond to truck route sections and non-truck route sections, ferry sections and non-ferry sections, locality names and ownership. The response includes a partitions attribute, which is an array of objects, each of which has an index (into the route coordinate array), distance and a value for each of the attributes requested in the partition parameter. Any or all of the following values can be used. Partition values: isTruckRoute – Distinguish between truck route sections and non-truck route sections  isFerry – Distinguish between ferry sections and non-ferry sections  locality – Include the locality name for the route partition   ownership - Include road ownership, simplifyDirections: bool=false # Combines driving directions that include short segments with a different name, and no turns, into the enclosing continuous, same-named directions, e.g. Short bridges, overpasses, or tunnels that interrupt continuous travel on a highway., simplifyThreshold: int=250 # The default distance threshold to simplify directions is 250 metres. Segments that are longer than this value will remain in the directions.If simplifyDirections is false, this value will be ignored., listRestrictions: bool=false # Include a list of all restriction IDs impacting the direction of travel along the base route. Default is false., restrictionSource: str=ITN # Specify the source of road restrictions. Options include: ITN - Integrated Transportation Network.  RDM - Restriction Data Manager (**Note that the RDM option is only suitable for demos**). Default is ITN., excludeRestrictions: str=null # A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route., restrictionValues: str=null # A comma-separated list of restriction types and their values (**only suitable for demos**). If the parameters height, width, length and weight are provided but the restrictionValues parameter is not, those values will be translated into VERTICAL, HORIZONTAL, LENGTH and WEIGHT-GVW. If values are provided for both the vehicle dimension parameters and the restrictionValues parameter, only the restrictionValues parameter values will be used. VERTICAL - Height in metres (e.g., VERTICAL:4.5). HORIZONTAL - Width in metres (e.g., HORIZONTAL:3)LENGTH - Length in metres (e.g., LENGTH:8.2) WEIGHT-GVW - Gross vehicle weight in kilograms (e.g., WEIGHT-GVW:35000)WEIGHT-1AXLE - Single axle weight (e.g., WEIGHT-1AXLE:10000)WEIGHT-2AXLE - Tandem axle weight (e.g., WEIGHT-2AXLE:10000)WEIGHT-3AXLE - Tridem axle weight (e.g., WEIGHT-3AXLE:15000)NCV - No Commercial Vehicles (e.g., NCV:1)NSI - No Self Issue (**not implemented**)}\n@returns(200) turn-by-turn directions, geometry, distance, and time of the shortest or fastest route. End points are reordered to minimize total distance or time.\n\n@endgroup\n\n@end\n"}