CREATE response
Response
The solution to the Create request is the Create response:
{
"shifts": [
{
"pattern": "9:5",
"skill": "skill",
"from": "2023-12-25T09:00:00",
"to": "2023-12-25T17:00:00",
"value": 5
}
]
}
Created Shift
Used to represent the output. Each entry corresponds with a pattern that was given as input.
Property | Type | Description |
---|---|---|
pattern | string | The name of the corresponding pattern that was given as input. |
skill | string | The skill of the corresponding pattern. |
value | integer | The amount of people the solver chose to assign to this shift. |
from | datetime | Shift start time |
to | datetime | Shift end time |
Objective
The solver will try to find the best values to assign to each shift. In order to do this, constraints are used to
determine how good a solution is. These constraints represent different numbers used to score the solution. These
constraints are prioritised by being either HARD, MEDIUM or SOFT. All improvements in HARD constraints trump any
deterioration in MEDIUM or SOFT constraints. All improvements in MEDIUM constraints trump any deterioration in SOFT
constraints.
Constraints
In this table is a summary of all constraints and what they mean. The weight and priority of each constraint can be
adjusted using the weights
field in a solver request. An example of this can be found on this page in 'Single Day
Creation With Weights'. This is an advanced feature, the results of tweaking these weights is often hard to predict.
Name | Level | Description |
---|---|---|
Total Demand | HARD | The total required demand must be met (only relevant in fixed mode). |
Resource Availability | HARD | Only the maximum number of available resources for every resource type can be used. |
Min Time Between Shift Start | HARD | Two shifts with different start times cannot have start times closer to each other than the minimum allowed time specified (optionally) by the user. |
Under demand | MEDIUM | For every demand time block, the supply that is less than the demand must be minimised. |
Over demand | MEDIUM | For every demand time block, the supply that is more than the demand must be minimised. |
As Late As Possible | MEDIUM | Only relevant in flexible mode. When planning shifts, try to plan shifts as late as possible while respecting the Over Demand and Under Demand constraints. |
Costs | SOFT | Cost based minimisation of the shifts. |
Preference | SOFT | Preference based maximisation of the shifts. |
Explanation
Updated 5 months ago