recommend_option

This is a job insertion option returned from /v1/recommend. See Recommending Routes.

Name Type Description
delta_cost float The change in cost due to inserting the job.
delta_distance_meters float The change in route distance due to inserting the job.
delta_internal_cost float The change in internal cost (cost including violations and intangibles) due to inserting the job.
delta_working_time timespan The change in working time due to inserting the job.
job_index integer The index of the job, given by the number of stops of type job preceding the inserted job on the route.
route_index integer The index of the route containing the inserted job in recommend_option.routes.
routes route_response[] The multi-day route with the job inserted into it. Will have only a single element if inserted into a single-day route.
schedules schedule_response[] Schedules that had their base dates assigned, if any. See Routing with Schedules.

Example

{
  "delta_cost": 16.46,
  "delta_internal_cost": 21.59,
  "delta_working_time": "00:42:42",
  "delta_distance_meters": 28944.0,
  "route_index": 0,
  "job_index": 1,
  "routes": [
    {
      "id": "route1", ...
      "stops": [
        { "type": "depot", ... },
        { "id": "job2", ... },
        { "id": "job", ...  },
        { "id": "job3", ... },
        { "type": "depot", ... }
      ]
    }
  ]
}

See Also