Solution

GET

vrp

jobs

{id}

solution

Solution

curl --request GET \
  --url https://api.solvice.io/v2/vrp/jobs/{id}/solution \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.solvice.io/v2/vrp/jobs/{id}/solution', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.solvice.io/v2/vrp/jobs/{id}/solution",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.solvice.io/v2/vrp/jobs/{id}/solution"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.solvice.io/v2/vrp/jobs/{id}/solution")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "0000-00000-00000-0000",
  "status": "SOLVED",
  "score": {
    "hardScore": 0,
    "mediumScore": 0,
    "softScore": -12345,
    "feasible": true
  },
  "trips": [
    {
      "resource": "vehicle-1",
      "date": "2023-01-13T00:00:00Z",
      "departureTime": "2023-01-13T08:00:00Z",
      "visits": [
        {
          "job": "Job-1",
          "arrival": "2023-01-13T08:30:00Z",
          "serviceTime": 600,
          "travelTime": 1800,
          "distance": 15000,
          "location": {
            "latitude": 51.0543,
            "longitude": 3.7174
          },
          "waitTime": 0
        }
      ],
      "waitTime": 0,
      "travelTime": 3600,
      "distance": 30000,
      "workTime": 4200,
      "serviceTime": 600,
      "occupancy": 0.47
    }
  ],
  "totalWaitTimeInSeconds": 0,
  "totalTravelTimeInSeconds": 3600,
  "totalTravelDistanceInMeters": 30000,
  "totalServiceTimeInSeconds": 600,
  "occupancy": 0.47,
  "workloadFairness": 0.95,
  "unserved": [],
  "suggestions": [],
  "messages": [
    "Solution found in 2.5 seconds"
  ]
}

{
  "message": "<string>",
  "status": "OK"
}

{
  "message": "<string>",
  "status": "OK"
}

{
  "message": "<string>",
  "status": "OK"
}

Authorizations

Authorization

string

header

required

Api Key based authentication (apikey)

Path Parameters

string

required

Response

Status

OnRoute response from solve

string | null

Id of the solve job

Example:

"0000-00000-00000-0000"

status

enum<string> | null

Status of the solve job.

Available options:

ERROR,

QUEUED,

SOLVING,

SOLVED

Example:

"SOLVED"

score

object | null

The score of a solution shows how good this solution is w.r.t all the constraints. All solvers try to maximize the score.

Show child attributes

trips

object[]

Actual solution: trips per shift/day and per resource

Show child attributes

totalWaitTimeInSeconds

integer<int64> | null

Wait time for all resources

Example:

123

occupancy

number<double> | null

How full this schedule is in terms of work time (incl travel) over capacity. Eg 80%

Example:

0.8

totalTravelDistanceInMeters

integer<int64> | null

Travel distance for all resources in meters

Example:

123

totalTravelTimeInSeconds

integer<int64> | null

Travel time for all resources

Example:

123

totalServiceTimeInSeconds

integer<int64> | null

Service time for all resources

Example:

123

unserved

string[] | null

Unserved jobs

Example:

"[job-1]"

unservedReasons

object | null

Reasons why jobs could not be served, mapped by job name

Show child attributes

Example:

{
  "job-1": [
    "DATE_TIME_WINDOW_CONFLICT",
    "TRIP_CAPACITY"
  ]
}

suggestions

object[] | null

List of suggested assignments returned by suggest api call

Show child attributes

snapPointSuggestions

object[] | null

When options.snapPoints was set on the request, one feasibility result per (resource, requested time) pair.

Show child attributes

messages

string[] | null

Events and warnings generated during the solver execution

estimatedCost

object

Financial cost breakdown of the optimized solution. Only populated when costs configuration is provided in the request.

Show child attributes

Example:

{
  "totalCostEur": 450.75,
  "travelTimeCostEur": 125.5,
  "distanceCostEur": 87.5,
  "waitTimeCostEur": 15,
  "laborCostEur": 200,
  "activationCostEur": 50,
  "penaltyCostEur": 27.25
}

explanationTruncation

object

Reports that the explanation is incomplete because a limit in options.explanation was hit. Absent on a complete explanation. When present, a job with no entry in alternatives - and an unserved job whose unservedReasons list is empty - may simply never have been analysed.

Show child attributes

Example:

{
  "reason": "TIME_LIMIT_EXCEEDED",
  "message": "Explanation stopped after 30000 ms. Analysed 412 of 8186 jobs.",
  "analysedJobs": 412,
  "totalJobs": 8186,
  "cappedJobs": 0,
  "limitMillis": 30000
}

violations

object[] | null

Show child attributes

workloadFairness

number<double> | null

Solution

curl --request GET \
  --url https://api.solvice.io/v2/vrp/jobs/{id}/solution \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.solvice.io/v2/vrp/jobs/{id}/solution', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.solvice.io/v2/vrp/jobs/{id}/solution",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.solvice.io/v2/vrp/jobs/{id}/solution"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.solvice.io/v2/vrp/jobs/{id}/solution")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "0000-00000-00000-0000",
  "status": "SOLVED",
  "score": {
    "hardScore": 0,
    "mediumScore": 0,
    "softScore": -12345,
    "feasible": true
  },
  "trips": [
    {
      "resource": "vehicle-1",
      "date": "2023-01-13T00:00:00Z",
      "departureTime": "2023-01-13T08:00:00Z",
      "visits": [
        {
          "job": "Job-1",
          "arrival": "2023-01-13T08:30:00Z",
          "serviceTime": 600,
          "travelTime": 1800,
          "distance": 15000,
          "location": {
            "latitude": 51.0543,
            "longitude": 3.7174
          },
          "waitTime": 0
        }
      ],
      "waitTime": 0,
      "travelTime": 3600,
      "distance": 30000,
      "workTime": 4200,
      "serviceTime": 600,
      "occupancy": 0.47
    }
  ],
  "totalWaitTimeInSeconds": 0,
  "totalTravelTimeInSeconds": 3600,
  "totalTravelDistanceInMeters": 30000,
  "totalServiceTimeInSeconds": 600,
  "occupancy": 0.47,
  "workloadFairness": 0.95,
  "unserved": [],
  "suggestions": [],
  "messages": [
    "Solution found in 2.5 seconds"
  ]
}

{
  "message": "<string>",
  "status": "OK"
}

{
  "message": "<string>",
  "status": "OK"
}

{
  "message": "<string>",
  "status": "OK"
}

VRP API

Fill API

Authorizations

Path Parameters

Response