Solution

The solution endpoint returns the solution of the solve job. It contains the score, the trips and the violations.

Name	Type	Description
`status`	String	Status of the Response (`QUEUED`, `SOLVING`, `SOLVED` or `ERROR`)
`score`	[Score]	Score tells you how good a solution is.
`unresolved`	any	Constraints that are violated
`trips`	[Trip]	Actual solution: trips per workingtime/day and per resource
`totalWaitTimeInSeconds`	integer(int64)	Wait time for all resources
`totalTravelTimeInSeconds`	integer(int64)	Travel time for all resources
`totalTravelDistanceInMeters`	integer(int64)	Travel distance for all resources
`totalServiceTimeInSeconds`	integer(int64)	Service time for all resources
`unserved`	[string]	When `options.partialPlanning` is set, then this might result in a list of jobs that are unserved and not in the planning.
`violations`	[Violation]	A constraint that is broken in the current solution with a certain value (penalty) and a certain level (hard, soft, medium).]
`workloadFairness`	number(double)	How fair a certain workload is divided over the resources.

Example:

solution
{
  "score": {
    "hardScore": 0,
    "mediumScore": -25200,
    "softScore": -6924,
    "feasible": true
  },
  "trips": [
    {
      "visits": [
        {
          "arrival": "2023-01-13T08:44:54",
          "job": "JOB-6",
          "location": "50.89633806889935;4.45161298168845"
        },
        {
          "arrival": "2023-01-13T10:21:25",
          "job": "JOB-5",
          "location": "50.94837893617721;4.001604640663746"
        },
        {
          "arrival": "2023-01-13T11:55:17",
          "job": "JOB-10",
          "location": "50.78868282668716;4.167956383823208"
        }
      ],
      "resource": "R-1",
      "date": "2023-01-13",
      "departureTime": "2023-01-13T08:00:00",
      "waitTime": 0,
      "travelTime": 6917,
      "workTime": 17717,
      "serviceTime": 10800
    }
  ],
  "totalTravelTimeInSeconds": 6917,
  "totalServiceTimeInSeconds": 10800,
  "workloadFairness": 0.5,
  "unserved": [
    "JOB-1",
    "JOB-2",
    "JOB-3",
    "JOB-4",
    "JOB-7",
    "JOB-8",
    "JOB-9"
  ],
  "status": "SOLVED"
}

Score

Name	Type	Description
`hardScore`	integer(int64)	The score of the constraints that are hard. This should be 0 in order to be feasible.
`mediumScore`	integer(int64)	The score of the constraints that are medium.
`softScore`	integer(int64)	The score of the constraints that are soft.
`feasible`	boolean	Feasibility of the solution is determined by the fact if there are violated hard constraints or not.

Trip

Name	Type	Description
`visits`	Visit	Visits of the trip.
`resource`	string	Resource name
`date`	string	Date of the trip
`departureTime`	string	Departure time of the trip
`waitTime`	integer(int64)	Wait time of the trip
`travelTime`	integer(int64)	Travel time of the trip
`workTime`	integer(int64)	Work time of the trip
`serviceTime`	integer(int64)	Service time of the trip

Visit

Name	Type	Description
`arrival`	string	Arrival time of a job
`job`	string	Job name
`location`	string	Location of the visit

Score

OnRoute response from solve

Explanation

{
  "id": "0000-00000-00000-0000",
  "status": "SOLVED",
  "score": {
    "hardScore": 123,
    "mediumScore": 123,
    "softScore": 123,
    "feasible": true
  },
  "unresolved": "<any>",
  "trips": [
    {
      "visits": [
        {
          "arrival": "2022-03-10T16:15:50.000Z",
          "serviceTime": 123,
          "travelTime": 123,
          "distance": 123,
          "job": "<string>",
          "activity": "<string>",
          "location": {
            "latitude": 50.0987624,
            "longitude": 4.93849204,
            "name": "<string>"
          },
          "latlng": [
            123
          ],
          "breakTime": 123,
          "waitTime": 123
        }
      ],
      "resource": "resource-1",
      "date": "2021-01-01T00:00:00.000Z",
      "departureTime": "2021-01-01T08:00:00.000Z",
      "waitTime": 0,
      "travelTime": 123,
      "workTime": 123,
      "serviceTime": 123,
      "polyline": "polyline",
      "occupancy": 0.8,
      "start": {
        "arrival": "2022-03-10T16:15:50.000Z",
        "serviceTime": 123,
        "travelTime": 123,
        "distance": 123,
        "job": "<string>",
        "activity": "<string>",
        "location": {
          "latitude": 50.0987624,
          "longitude": 4.93849204,
          "name": "<string>"
        },
        "latlng": [
          123
        ],
        "breakTime": 123,
        "waitTime": 123
      },
      "end": {
        "arrival": "2022-03-10T16:15:50.000Z",
        "serviceTime": 123,
        "travelTime": 123,
        "distance": 123,
        "job": "<string>",
        "activity": "<string>",
        "location": {
          "latitude": 50.0987624,
          "longitude": 4.93849204,
          "name": "<string>"
        },
        "latlng": [
          123
        ],
        "breakTime": 123,
        "waitTime": 123
      },
      "distance": 123
    }
  ],
  "totalWaitTimeInSeconds": 123,
  "occupancy": 0.8,
  "totalTravelDistanceInMeters": 123,
  "totalTravelTimeInSeconds": 123,
  "totalServiceTimeInSeconds": 123,
  "unserved": "[job-1]",
  "suggestions": [
    {
      "score": {
        "hardScore": 123,
        "mediumScore": 123,
        "softScore": 123,
        "feasible": true
      },
      "assignments": [
        {
          "job": "<string>",
          "resource": "<string>",
          "suggestedArrival": "2022-03-10T16:15:50.000Z",
          "latestArrival": "2022-03-10T16:15:50.000Z",
          "executedAfter": "<string>",
          "score": {
            "hardScore": 123,
            "mediumScore": 123,
            "softScore": 123,
            "feasible": true
          },
          "scoreExplanation": {
            "constraint": "TRIP_CAPACITY",
            "score": "<string>"
          },
          "suggestedInitialArrival": "2022-03-10T16:15:50.000Z",
          "violations": [
            {
              "constraint": "TRIP_CAPACITY",
              "score": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "messages": [
    "<string>"
  ],
  "violations": [
    {
      "name": "maxDistance",
      "value": 100,
      "level": "[HARD, MEDIUM, SOFT]"
    }
  ],
  "workloadFairness": 123
}

Platform

VRP API

FILL API

CREATE API

Score

Trip

Visit

Score

Platform

VRP API

FILL API

CREATE API

​Score

​Trip

​Visit

​Score

Score

Trip

Visit

Score