VRt.Routing [RO] (6.20.2289)

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

Building a route between locations considering taking traffic jams.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New request for route calculation.

required
Array of objects (waypoint) [ 2 .. 15001 ] items

Array of geographical points to build path between them.

transport_type
string (transport_type)
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 9 more

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_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

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>

Departure date and time according to the ISO 8601.

result_timezone
integer<int32> [ -12 .. 12 ]
Default: 0

Time zone for calculation results.

detail
boolean
Default: false

Planning a detailed route.

full_segments
boolean
Default: true

Return full segments list.

polyline
boolean
Default: true

Generate a polyline between points.

Responses

Response Schema: application/json
required
object (tracedata)

Data for request tracing.

required
object (route)

Information about the planned route.

Request samples

Content type
application/json
{
  • "transport_type": "CAR",
  • "detail": true,
  • "polyline": true,
  • "waypoints": [
    ]
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "route": {
    }
}

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 (waypoint) [ 2 .. 15001 ] items

Array of geographical points to calculate the distances and times between them.

transport_type
string (transport_type)
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 9 more

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_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

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>

Departure date and time according to the ISO 8601.

Responses

Response Schema: application/json
required
object (tracedata)

Data for request tracing.

required
object (routing_matrix)

Time and distance matrix.

Request samples

Content type
application/json
{
  • "transport_type": "CAR",
  • "waypoints": [
    ]
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "matrix": {
    }
}

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 ]

Current health.

Response samples

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 ]

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 ]

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

Build version.
Contains backwards compatible bug fixes and docs update.

Response samples

Content type
application/json
{
  • "major": 4,
  • "minor": 4,
  • "build": "1754RC"
}

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:
string (file_html)

File with data in HTML format.

Response samples

Content type
application/json
{
  • "resource_id": "resource_id",
  • "detail": {
    }
}