Route Plan

A Route Plan describes the planned routes and Estimated Arrival Times (ETAs) for all Waypoints in a Vehicle’s current Mission. ETAs are computed based on routing and timing attributes such as boarding and deboarding durations provided by the Client for pickup and dropoff Waypoint Actions.

Vehicle Route Plan

The Vehicle object includes a route_plan field that provides a timestamped plan with estimated arrival times and routing information for the waypoints in the current mission.

The RoutePlan contains:

• timestamp – The time when the routes were last computed.

• routes – An ordered array of route objects for each waypoint in the mission. The first route is from the vehicle’s current location to the first waypoint, the second route from the first waypoint to the second waypoint, and so on.

Each entry in the routes array contains:

• endWaypointId – The identifier of the destination Waypoint for this route object.

• estimatedTravelTime – The estimated travel time for this specific route object. For the first route, this estimation is relative to the current vehicle location.

• estimatedTimeOfArrival – The estimated time when the vehicle will arrive at the destination Waypoint.

• geometry – A polyline representation of the route path.

"routePlan": {
  "timestamp": "2024-03-13T14:20:00.000Z",
  "routes": [
    {
      "endWaypointId": "96c85ba5-0b0d-4e52-b714-6d006e8020c8",
      "estimatedTravelTime": "300s",
      "estimatedTimeOfArrival": "2024-03-13T14:25:13.664Z",
      "geometry": [
        {
          "latitude": 53.599495,
          "longitude": 10.041272
        },
        {
          "latitude": 53.600123,
          "longitude": 10.042456
        }
      ]
    },
    {
      "endWaypointId": "bd9c2f54-783e-4421-ab7c-687fea3eb71d",
      "estimatedTravelTime": "180s",
      "estimatedTimeOfArrival": "2024-03-13T14:28:13.664Z",
      "geometry": [
        {
          "latitude": 53.600123,
          "longitude": 10.042456
        },
        {
          "latitude": 53.604013,
          "longitude": 10.043214
        }
      ]
    }
  ]
}

Enhanced Timing Controls

Clients provide additional time information attributes for Waypoint Actions that are used in ETA calculations, including:

Pickup Action

• boarding_duration – The duration reserved for passenger boarding at pickup locations. This is especially useful when boarding durations depend on passengers’ special needs (wheelchair, child seat, luggage, etc.). This time is included when computing estimated arrival times for later waypoints.

• expected_vehicle_boarding_time – The expected time when passenger boarding should start. This time is included when computing estimated arrival times for later waypoints.

Dropoff Action

• deboarding_duration – The duration reserved for passenger deboarding. Certain passenger groups may need a longer time to safely deboard. This time is included when computing estimated arrival times for later waypoints.

Automatic Updates

Route plan information is automatically updated when the vehicle mission is updated.