Route Planner feature specification

The Route Planner result feature is a feature of MultiLineString type. The geometry of the feature contains the route and the properties contain route details. The feature properties contain information about a route and execution plan for an agent.

Feature properties

The feature properties contain information about the route:

Name Description
agent_index Index of the corresponding agent in the agents input array
distance Distance in meters for the whole agent route
time Time in seconds, that contains travel time
total_time Total time in seconds, contains travel time and action durations
start_time Start time for the agent
mode Requested transportation or travel mode
actions An array of Actions corresponds to the single steps for the agent.
waypoints An array of Waypoints corresponds to the jobs execution plan.
legs An array of RouteLeg. Each leg represents a route from one waypoint to another.

Actions

Contains single operation information:

Name Description
type Type of the action. Possible values: 'start', 'end', 'pickup', 'delivery'
start_time Execution start time
duration Action duration
shipment_index Index of the shipment in original shipments array
shopment_id Shipment unique identifier
job_index Index of the job in original jobs array
job_id Job unique identifier if specified
waypoint_index Index of the correspinding waypoint

Waypoints

Contains information about a waypoint location and works planned in the location.

Name Description
original_location Original location. An array of the coordinates: [lon, lat]
original_location_index Index of the original location if specified in locations input
original_location_id Identifier of the original location if specified in locations input
location Matched location. An array of the coordinates: [lon, lat]
start_time Actions execution start time, corresponds to arrival time for the waypoint.
duration All actions duration
actions An array of Actions planned for the waypoint
prev_leg_index Route leg that leads to the waypoint
next_leg_index Route leg that leads off the waypoint

RouteLeg

Contains information about a route between 2 locations.

Name Description
distance Length of the route leg in meters
time Time in seconds for the route leg
steps An array of LegStep. Steps of the route
from_waypoint_index Index of the previous waypoint
to_waypoint_index Index of the next waypoint

LegStep

Contains information about a separate step of RouteLeg:

Name Description
distance Distance in meters for the step
time Time in seconds for the step
from_index An index of the way start point in the corresponding feature coordinates array
to_index An index of the way end point in the corresponding feature coordinates array