VRt.Routing [RT] (7.9.2527)

Veeroute Support Team: servicedesk@veeroute.com License: Proprietary Terms of Service

Veeroute company website

Description

VRt.Routing is designed to find a route between locations and build time-distance matrices.

Features

Getting the distance and time between two locations, including traffic jams
Finding a route between specified locations
Creating a time-distance matrix

Entity relationship diagram

erd

Route

Building a path of movement between geographic points.

Route between points

Constructing a route between points, taking into account the specified order and time at each stop. When specifying the departure time departure_time, traffic jams are taken into account.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

New request for route calculation.

required	Array of objects (route_waypoint) [ 2 .. 15001 ] items Array of geographical points to build path between them.
transport_type	string (transport_type) Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Transport types: `CAR` - car `TRUCK_1500` - truck with permissible weight 1500 kg `TRUCK_3000` - truck with permissible weight 3000 kg `TRUCK_5000` - truck with permissible weight 5000 kg `TRUCK_10000` - truck with permissible weight 10000 kg `TRUCK_20000` - truck with permissible weight 20000 kg `TRUCK_10000_L75_H35_W24_6000` - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg `TRUCK_18000_L95_H40_W26_11000` - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg `TRUCK_GARBAGE_1` - truck for transporting garbage (type 1) `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2) `TUK_TUK` - tuk-tuk `BICYCLE` - bicycle `PEDESTRIAN` - pedestrian `PUBLIC_TRANSPORT` - public transport `TELEPORT` - teleport (instant movement between points) Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.
	object (geo_settings) Geodata usage settings.
departure_time	string or null <date-time> Default: null Example: "2024-11-21T09:30:00+03:00" Departure date and time according to the ISO 8601.
result_timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Time zone for calculation results.
detail	boolean Default: false Example: "true" Building a detailed route - adds paths from points that are not on roads to nearby roads.
full_segments	boolean Default: true Example: "false" Return a complete list of route segments. If the option is disabled, a short list is returned for simplified route display.
polyline	boolean Default: true Example: "false" Generate a polyline between points.
trackpoint_time	boolean Default: false Example: "true" Generate times at intermediate points along the track.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	object (route) Information about the planned route.

Request samples

Payload
Python

Content type

application/json

{"transport_type": "CAR",
"detail": true,
"polyline": true,
"waypoints": [{"name": "waypoint_01",
"duration": "PT10M",
"geopoint": {"latitude": 55.7464,
"longitude": 37.493
}
},
{"name": "waypoint_02",
"duration": "PT10M",
"geopoint": {"latitude": 55.6044,
"longitude": 37.6639
}
},
{"name": "waypoint_03",
"duration": "PT10M",
"geopoint": {"latitude": 55.7305,
"longitude": 37.7387
}
},
{"name": "waypoint_04",
"duration": "PT10M",
"geopoint": {"latitude": 55.7329,
"longitude": 37.6437
}
},
{"name": "waypoint_05",
"duration": "PT10M",
"geopoint": {"latitude": 55.7974,
"longitude": 37.7994
}
}
]
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "ROUTING",
"operation": "run_route_calculation",
"time": "2024-11-23T15:38:46.819189Z"
},
"route": {"legs": [{"steps": [{"transport_type": "CAR",
"polyline": [{"latitude": 55.746479,
"longitude": 37.49293,
"time": "2024-11-23T15:42:41Z"
},
{"latitude": 55.746405,
"longitude": 37.492664,
"time": "2024-11-23T15:42:42Z"
},
{"latitude": 55.746625,
"longitude": 37.492461,
"time": "2024-11-23T15:42:43Z"
}
]
}
],
"departure_name": "waypoint_01",
"destination_name": "waypoint_02",
"statistics": {"distance": 17101,
"time_window": {"from": "2024-11-23T17:58:45Z",
"to": "2024-11-23T18:35:45Z"
},
"duration": "PT27M",
"stopping_time": "PT10M"
}
}
],
"statistics": {"distance": 17101,
"time_window": {"from": "2024-11-23T17:58:45Z",
"to": "2024-11-23T18:35:45Z"
},
"duration": "PT27M",
"stopping_time": "PT10M"
}
}
}

Matrix

Build a routing matrix.

To build the matrix, the geo_provider parameter is not taken into account; the default geo-provider is always used.

Time-distance matrix

Creating time-distance matrices between each pair of locations. The result of this method may slightly differ from the route method.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

New request for matrix calculation.

required	Array of objects (routing_matrix_waypoint) [ 2 .. 15001 ] items Array of geographical points to calculate the distances and times between them. The for all matrices (with different `transport_type`) must be in the same order.
transport_type	string (transport_type) Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more Example: "CAR" Transport types: `CAR` - car `TRUCK_1500` - truck with permissible weight 1500 kg `TRUCK_3000` - truck with permissible weight 3000 kg `TRUCK_5000` - truck with permissible weight 5000 kg `TRUCK_10000` - truck with permissible weight 10000 kg `TRUCK_20000` - truck with permissible weight 20000 kg `TRUCK_10000_L75_H35_W24_6000` - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg `TRUCK_18000_L95_H40_W26_11000` - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg `TRUCK_GARBAGE_1` - truck for transporting garbage (type 1) `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2) `TUK_TUK` - tuk-tuk `BICYCLE` - bicycle `PEDESTRIAN` - pedestrian `PUBLIC_TRANSPORT` - public transport `TELEPORT` - teleport (instant movement between points) Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.
	object (geo_settings) Geodata usage settings.
departure_time	string or null <date-time> Default: null Example: "2024-11-21T09:30:00+03:00" Departure date and time according to the ISO 8601.
dataset_name	string (dataset_name) [ 0 .. 512 ] characters Example: "custom_dataset_one" The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	object (routing_matrix) Routing matrix. Contains durations and distances between points.

Request samples

Payload

Content type

application/json

{"transport_type": "CAR",
"waypoints": [{"name": "waypoint_01",
"geopoint": {"latitude": 55.7464,
"longitude": 37.493
}
},
{"name": "waypoint_02",
"geopoint": {"latitude": 55.6044,
"longitude": 37.6639
}
},
{"name": "waypoint_03",
"geopoint": {"latitude": 55.7305,
"longitude": 37.7387
}
},
{"name": "waypoint_04",
"geopoint": {"latitude": 55.7329,
"longitude": 37.6437
}
},
{"name": "waypoint_05",
"geopoint": {"latitude": 55.7974,
"longitude": 37.7994
}
}
]
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "example_username",
"company": "example_company",
"env": "edge7",
"pod": "aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee",
"service": "ROUTING",
"operation": "run_matrix_calculation",
"time": "2024-11-23T15:42:47.418015Z"
},
"matrix": {"waypoints": [{"geopoint": {"latitude": 55.7305,
"longitude": 37.7387
},
"name": "waypoint_03"
},
{"geopoint": {"latitude": 55.7464,
"longitude": 37.493
},
"name": "waypoint_01"
},
{"geopoint": {"latitude": 55.6044,
"longitude": 37.6639
},
"name": "waypoint_02"
},
{"geopoint": {"latitude": 55.7974,
"longitude": 37.7994
},
"name": "waypoint_05"
},
{"geopoint": {"latitude": 55.7329,
"longitude": 37.6437
},
"name": "waypoint_04"
}
],
"distances": [[0,
20315,
37877,
24153,
17333
],
[29204,
0,
15069,
20098,
9181
],
[36075,
15410,
0,
23216,
16063
],
[25718,
23050,
24467,
0,
12455
],
[17072,
6901,
16961,
13555,
0
]
],
"durations": [[0,
20,
28,
26,
18
],
[23,
0,
16,
22,
9
],
[27,
16,
0,
25,
17
],
[26,
20,
24,
0,
14
],
[18,
7,
17,
15,
0
]
]
}
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

The current health indicator of the service.

0.0 means the service is not ready to perform tasks.
1.0 means the service is fully ready to perform tasks.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).
minor required	integer <int32> [ 0 .. 111 ] Example: "5" Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 5,
"build": "3754RC"
}

Getting the documentation

Getting the file with this service documentation.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key",
"detail": {"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
}
}
}

VRt.Routing [RT] (7.9.2527)

Description

Features

Entity relationship diagram

Route

Route between points

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Matrix

Time-distance matrix

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

System

Checking the availability

Responses

Response Schema: application/json

Response samples

Getting the service version

Responses

Response Schema: application/json

Response samples

Getting the documentation

path Parameters

Responses

Response Schema: text/htmltext/plaintext/html

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Response Schema:
text/html