Skip to main content

Route

Store information about a saved plan.

Fields​

id​

A uuid reference to the route

steps​

Steps represent the route plan if a form of sequenced activities.

steps.location​

Coordinated for where to execute activities.

steps.activities​

A list of activities to be executed during a single step.

steps.load​

Total capacity remaining on the route while at a given step.

steps.time​

The total cumulative time span used at a given step.

stats​

Stats for the route.

stats.cost​

Sum of all costs for the route. Calculated from fleet types limits.

stats.distance​

Total planned distance for the route in metres

stats.duration​

A breakdown of duration time for the route in minutes.

Example

{
  "duration": {
    "driving": 20,
    "service": 20,
    "waiting": 15,
    "break": 0
  }
}

status​

Current status of the route. Can be either of READY, STARTED, DONE or CANCELED.

planner_request_id​

A reference to the plan id for the route.

fleet_actor_id​

A reference to the fleet actor used for the planning the route.

service_actor_id​

A reference to the assigned service actor.

polyline​

Spatial connections of route segements.