Skip to main content
Simply fetch the solution in the jobs/:id/solution endpoint and receive the shift assignments. For every shift defined by its name we will assign the best employee.
NameTypeDescription
idstring (uuid)Id of the solve job
statusstringStatus of the Response (SOLVING, SOLVED, or QUEUED)
scoreScoreScore of the solution
assignmentsAssignmentActual solution: assignments per shift
unassignedarray of stringUnassigned shifts
suggestionsSuggestionList of suggested shift assignments returned by suggest api call
violationsListList of violated constraints

​
Assignment

NameTypeDescription
shiftstringShift id
fromstringStart date-time
tostringEnd date-time
skillslist of stringList of skills
employeestringEmployee id
travelTimeInSecondsnumberTravel time in seconds
[
  {
    "name": "Morning Shift 1",
    "from": "2020-06-26T08:00:00",
    "to": "2020-06-30T08:00:00",
    "employee": "John Dory",
    "skills": [
      "waiter",
      "bar"
    ]
  }
]

​
ViolatedConstraint

NameTypeDescription
namestringName of the constraint.
valuenumberValue of the unresolved constraint. The higher, the more deviation from perfection this constraint has.
levelstringLevel of unresolved constraint. (HARD, SOFT)

​
Suggestion

​
Weights

We take into account many constraints. Let us know if there are any constraints that you think are missing.
NamePropertyDefault priorityDescription
Maximum Working DaysmaxWorkingDaysHARDAn employee should not work more than contract.maxWorkingDays days in the planning horizon.
Maximum HoursmaxHoursHARDAn employee should not work more than contract.max hours in the planning horizon.
Minimum HoursminHoursHARDAn employee should not work less than contract.min hours in the planning horizon. Please ensure minimum feasibility over the whole workforce.
Earliest Shift StartshiftStartHARDEarliest time contract.earliestShiftStart in a day when an employee is allowed to work
Latest Shift StartlatestShiftStartHARDEarliest time contract.latestShiftStart in a day when an employee is allowed to start work
Latest Shift EndshiftEndHARDLatest time contract.latestShiftEnd in a day when an employee is allowed to end work
Maximum Shift LengthmaxShiftHARDMaximum time contract.maxShiftLength that an employee is allowed to work
DayOfWeek WorkingdayOfWeekHARDRestricts employee availability based on days in the week that
Minimum Shift LengthminShiftHARDMinimum time contract.maxShiftLength that an employee is allowed to work
Maximum Shifts On Same DaysameDayHARDMaximum number of shifts that an employee is allowed to work
Minimum Rest On Same DaysameDayMinRestHARDMinimum resting period between two shifts on the same day
Employee AvailabilityavailabilityHARDDate-time range of employee’s availability
Locked AssignmentlockedHARDTake into account assignments that are fixed during the solve
Maximum Consecutive Working DaysmaxConsecutiveHARDNo more than contract.maxConsecutiveWorkDays consecutive shifts.
Minimum RestminRestHARDMinimum resting between two shifts (irrespective of shifts)
No Concurrent AssignmentsconcurrentHARDAn employee cannot have two assignments on the same time. (This should never happen)
Skill Requirement for shiftsrequirementsHARDMultiple shifts can have a shared requirement for a skill
Employee Skill MatchskillsHARDAssign employees to match according to their skills and the required skills for a shift
Travel TimedistanceSOFTTravel from home to shift location
PriorityprioritySOFTShift Priorities
Shift Employee PreferenceprefMEDIUMA preference for a certain shift assignment for an employee
Financial CostscostsSOFTSome shifts incur a higher cost when they are assigned to (opposite of priority)
Wage Costs per EmployeewagesSOFTHourly wage cost per employee influences choice of employee
Unassigned EmployeeunassignedMEDIUMMinimise the number of unassigned employees
Employee Skill Match SoftsoftSkillsSOFTAssign employees to match according to their skills and the required skills for a shift (soft rule)
Employee Critical Skill MatchcriticalSkillsSOFTPrefer assigning critical shifts first
Employee working daysworkingHARDRespect employees working days
Shift blakclistblacklistHARDDo not assign shift to blacklisted employees
EfficiencyefficiencySOFTWeight of the efficiency cost per employee
Employee skill level matchsoftSkillLevelSOFTMatch the skill level
The weights and priorities of these constraints can be set in the solve request by adding a weights object to the request where each property that we want to customise has a string with the format “<weight><priority>” where <weight> is a positive integer number and <priority> can assume one of the following values: soft, medium and hard. hard constraints are more important than medium constraints and medium constraints are more important than soft. Between violations of two constraints with the same priority, the solver will choose the one with the minimum weight. In the example below we are customising the weights for the lockedand unassigned constraints. 
{
  "weights": {
    "locked": "100hard",
    "unassigned": "5soft"
  }
}