Skip to main content
GET
Solution

Authorizations

Authorization
string
header
required

Api Key based authentication (apikey)

Path Parameters

id
string
required

Response

Status

OnRoute response from solve

trips
object[]
required

Actual solution: trips per shift/day and per resource

id
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.

unresolved
any

Constraints that are violated

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

Example:
suggestions
object[] | null

List of suggested assignments returned by suggest api call

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.

Example:
violations
object[] | null
workloadFairness
number<double> | null