Info

Explanation

Changed on

Contains the explanation, once solved.

get/v2/vrp/jobs/{id}/explanation

Request

  • Base URL
    https://api.solvice.io
  • URL
    https://api.solvice.io/v2/vrp/jobs/{id}/explanation
  • Auth
    API key in header Authorization

Path parameters

idstring required

Response

Status

alternativesobject nullable

When options.explanation.enabled is set to true, this field will contain the alternatives for the solution.The key is the job name and the value is the list of assignments. Each assignment contains the resource, the date, and the score. In this way, you can check the impact of the alternative on the score.

Example response

{
  "score": {
    "hardScore": -2000,
    "mediumScore": 0,
    "softScore": -15000,
    "feasible": false
  },
  "conflicts": [
    {
      "constraint": "TIME_WINDOW_CONFLICT",
      "score": "-1000",
      "job": "Job-1",
      "resource": "vehicle-1"
    },
    {
      "constraint": "TAG_HARD",
      "score": "-1000",
      "job": "Job-2",
      "resource": "vehicle-1",
      "tag": "electrical"
    }
  ],
  "unresolved": [
    {
      "constraint": "TRAVEL_TIME",
      "score": "-15000"
    }
  ],
  "alternatives": {
    "Job-1": [
      {
        "job": "Job-1",
        "resource": "vehicle-2",
        "suggestedArrival": "2023-01-13T09:30:00Z",
        "latestArrival": "2023-01-13T10:00:00Z",
        "executedAfter": "Job-0",
        "score": {
          "hardScore": 0,
          "mediumScore": 0,
          "softScore": -1500,
          "feasible": true
        }
      }
    ]
  }
}

Changes

  • d015cfede38eRevision changes
    • warning

      added the new DEPOT_CAPACITY enum value to the / response property for the response status

    • warning

      added the new DEPOT_CAPACITY enum value to the // response property for the response status

    • warning

      added the new DEPOT_COST enum value to the / response property for the response status

    • warning

      added the new DEPOT_COST enum value to the // response property for the response status

    • warning

      added the new DEPOT_TIME_WINDOW enum value to the / response property for the response status

    • warning

      added the new DEPOT_TIME_WINDOW enum value to the // response property for the response status

    • warning

      added the new END_DEPOT enum value to the / response property for the response status

    • warning

      added the new END_DEPOT enum value to the // response property for the response status

    • warning

      added the new LOAD_COMPATIBILITY enum value to the / response property for the response status

    • warning

      added the new LOAD_COMPATIBILITY enum value to the // response property for the response status

    • warning

      added the new MAX_DRIVE_DISTANCE enum value to the / response property for the response status

    • warning

      added the new MAX_DRIVE_DISTANCE enum value to the // response property for the response status

    • warning

      added the new SAME_DAY enum value to the / response property for the response status

    • warning

      added the new SAME_DAY enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

  • a35725e2af55Revision changes
    • warning

      added the new GROUP_SEQUENCE enum value to the / response property for the response status

    • warning

      added the new GROUP_SEQUENCE enum value to the // response property for the response status

    • warning

      added the new JOB_PROXIMITY enum value to the / response property for the response status

    • warning

      added the new JOB_PROXIMITY enum value to the // response property for the response status