From b53a4bdd47674bf639012cb914183ceb9cbea121 Mon Sep 17 00:00:00 2001 From: BK01 Date: Thu, 14 Mar 2024 10:23:52 -0700 Subject: [PATCH] Update router.json removed /truck/distance/betweenPairs (not supported) --- router/router.json | 496 --------------------------------------------- 1 file changed, 496 deletions(-) diff --git a/router/router.json b/router/router.json index 95dfdf7..066133b 100644 --- a/router/router.json +++ b/router/router.json @@ -2533,502 +2533,6 @@ } } }, - "/truck/distance/betweenPairs.{outputFormat}": { - "get": { - "summary": "Get distance and travel time between each pair of geographic points for a commercial vehicle", - "description": "Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints for a commercial vehicle. The number of fromPoints times the number of toPoints should not exceed 100 or the request will time out.", - "tags": [ - "distance" - ], - "parameters": [ - { - "name": "outputFormat", - "in": "path", - "description": "Format of representation", - "required": true, - "schema": { - "type": "string", - "enum": [ - "json", - "html" - ], - "default": "json" - }, - "example": "json" - }, - { - "name": "fromPoints", - "in": "query", - "description": "A comma-separated list of origin points. See fromPoints", - "required": true, - "schema": { - "type": "string" - }, - "example": "-123.70794,48.77869,-123.53785,48.38200" - }, - { - "name": "toPoints", - "in": "query", - "description": "A comma-separated list of destination points. See toPoints", - "required": true, - "schema": { - "type": "string" - }, - "example": "-124.972951,49.715181,-123.139464,49.704015" - }, - { - "name": "maxPairs", - "in": "query", - "description": "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.", - "required": false, - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "outputSRS", - "in": "query", - "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS", - "required": false, - "schema": { - "type": "integer", - "enum": [ - 4326, - 4269, - 3005, - 26907, - 26908, - 26909, - 26910, - 26911 - ], - "default": 4326 - } - }, - { - "name": "criteria", - "in": "query", - "description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "shortest", - "fastest" - ], - "default": "fastest" - } - }, - { - "name": "distanceUnit", - "in": "query", - "description": "distance unit of measure (e.g., km, mi). Default is km.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "km", - "mi" - ], - "default": "km" - } - }, - { - "name": "correctSide", - "in": "query", - "description": "If true, route starts and ends on same side of road as start and end points.Default is false.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "departure", - "in": "query", - "description": "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", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "truckRouteMultiplier", - "in": "query", - "description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.", - "required": false, - "schema": { - "type": "integer", - "default": 9 - } - }, - { - "name": "height", - "in": "query", - "description": "The height of the truck in metres (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "width", - "in": "query", - "description": "The width of the truck in metres (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "length", - "in": "query", - "description": "The length of the truck in metres (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "weight", - "in": "query", - "description": "The weight of the truck in kilograms (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "enable", - "in": "query", - "description": "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 demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - 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
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default", - "required": false, - "schema": { - "type": "string", - "default": "gdf,ldf,tr,xc,tc" - } - }, - { - "name": "disable", - "in": "query", - "description": "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 demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - 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
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default", - "required": false, - "schema": { - "type": "string", - "default": "td,ev,sc,tf,tl" - } - }, - { - "name": "snapDistance", - "in": "query", - "description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.", - "required": false, - "schema": { - "type": "integer", - "default": 1000 - } - }, - { - "name": "restrictionSource", - "in": "query", - "description": "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.", - "required": false, - "schema": { - "type": "string", - "default": "ITN" - } - }, - { - "name": "excludeRestrictions", - "in": "query", - "description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.", - "required": false, - "schema": { - "type": "string", - "default": null - } - }, - { - "name": "restrictionValues", - "in": "query", - "description": "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**)", - "required": false, - "schema": { - "type": "string", - "default": null - } - }, - { - "name": "routeDescription", - "in": "query", - "description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)", - "required": false, - "schema": { - "type": "string", - "default": "Routing results" - } - } - ], - "responses": { - "200": { - "description": "A list of routes and their route distances/times." - } - } - }, - "post": { - "summary": "Get distance and travel time between each pair of geographic points", - "description": "Represents the distance and time of the shortest or fastest paths between all pairs of fromPoints and toPoints. The number of fromPoints times the number of toPoints should not exceed 100 or the request will time out.", - "tags": [ - "distance" - ], - "parameters": [ - { - "name": "outputFormat", - "in": "path", - "description": "Format of representation", - "required": true, - "schema": { - "type": "string", - "enum": [ - "json", - "html" - ], - "default": "json" - }, - "example": "json" - }, - { - "name": "fromPoints", - "in": "query", - "description": "A comma-separated list of origin points. See fromPoints", - "required": true, - "schema": { - "type": "string" - }, - "example": "-123.70794,48.77869,-123.53785,48.38200" - }, - { - "name": "toPoints", - "in": "query", - "description": "A comma-separated list of destination points. See toPoints", - "required": true, - "schema": { - "type": "string" - }, - "example": "-124.972951,49.715181,-123.139464,49.704015" - }, - { - "name": "maxPairs", - "in": "query", - "description": "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.", - "required": false, - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "outputSRS", - "in": "query", - "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See outputSRS", - "required": false, - "schema": { - "type": "integer", - "enum": [ - 4326, - 4269, - 3005, - 26907, - 26908, - 26909, - 26910, - 26911 - ], - "default": 4326 - } - }, - { - "name": "criteria", - "in": "query", - "description": "Routing criteria to optimize (e.g., shortest, fastest). Default is fastest.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "shortest", - "fastest" - ], - "default": "fastest" - } - }, - { - "name": "distanceUnit", - "in": "query", - "description": "distance unit of measure (e.g., km, mi). Default is km.", - "required": false, - "schema": { - "type": "string", - "enum": [ - "km", - "mi" - ], - "default": "km" - } - }, - { - "name": "correctSide", - "in": "query", - "description": "If true, route starts and ends on same side of road as start and end points.Default is false.", - "required": false, - "schema": { - "type": "boolean", - "default": false - } - }, - { - "name": "departure", - "in": "query", - "description": "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", - "required": false, - "schema": { - "type": "string", - "format": "date-time" - } - }, - { - "name": "truckRouteMultiplier", - "in": "query", - "description": "The truck route multiplier value is used to multiply the cost (friction factors) of using roads that are not truck routes.", - "required": false, - "schema": { - "type": "integer", - "default": 9 - } - }, - { - "name": "height", - "in": "query", - "description": "The height of the truck in metres (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "width", - "in": "query", - "description": "The width of the truck in metres (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "length", - "in": "query", - "description": "The length of the truck in metres (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "weight", - "in": "query", - "description": "The weight of the truck in kilograms (**only suitable for demos**).", - "required": false, - "schema": { - "type": "number", - "default": null - } - }, - { - "name": "enable", - "in": "query", - "description": "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 demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - 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
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default", - "required": false, - "schema": { - "type": "string", - "default": "gdf,ldf,tr,xc,tc" - } - }, - { - "name": "disable", - "in": "query", - "description": "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 demos
tf – historic traffic congestion; disabled by default and only suitable for demos
ev – road events; disabled by default and only suitable for demos
td – time-dependency; disabled by default; disabling this disables sc, tf, and ev modules
tr – turn restrictions; enabled by default; if td is disabled, time-dependent turn restrictions are ignored
tc - turn costs (e.g., left turns take longer than right turns); enabled by default
xc - crossing costs (e.g., crossing a major road on a minor road takes longer than the other way around);enabled by default
gdf - 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
ldf - local distortion fields; applies friction factors to specific road segments to make them less attractive to trucks; enabled by default
tl - transportation line IDs; disabled by default", - "required": false, - "schema": { - "type": "string", - "default": "td,ev,sc,tf,tl" - } - }, - { - "name": "snapDistance", - "in": "query", - "description": "To route to a location that is further than 1000 metres from the road network, use the snapDistance parameter. The default is 1000 meters.", - "required": false, - "schema": { - "type": "integer", - "default": 1000 - } - }, - { - "name": "restrictionSource", - "in": "query", - "description": "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.", - "required": false, - "schema": { - "type": "string", - "default": "ITN" - } - }, - { - "name": "excludeRestrictions", - "in": "query", - "description": "A comma-separated list of restriction IDs. When provided the individual restrictions will be excluded (overridden) from the route.", - "required": false, - "schema": { - "type": "string", - "default": null - } - }, - { - "name": "restrictionValues", - "in": "query", - "description": "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**)", - "required": false, - "schema": { - "type": "string", - "default": null - } - }, - { - "name": "routeDescription", - "in": "query", - "description": "Route description (e.g., Shortest route from 1002 Johnson St, Victoria to 1105 Royal Ave,New Westminster)", - "required": false, - "schema": { - "type": "string", - "default": "Routing results" - } - } - ], - "responses": { - "200": { - "description": "A list of routes and their route distances/times." - } - } - } - }, "/truck/route.{outputFormat}": { "get": { "summary": "Get the path, distance and travel time between a series of geographic points for a commercial vehicle",