Solve Fill

POST

fill

solve

Solve

curl --request POST \
  --url https://api.solvice.io/v2/fill/solve \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employees": [
    {
      "name": "<string>",
      "home": {
        "lat": 123,
        "lon": 123
      },
      "availability": [
        {
          "from": "2023-11-07T05:31:56Z",
          "to": "2023-11-07T05:31:56Z",
          "location": {
            "lat": 123,
            "lon": 123
          }
        }
      ],
      "preference": [
        "<string>"
      ],
      "skills": [
        {
          "name": "<string>",
          "expiry": "2022-03-10",
          "weight": 123,
          "period": {
            "from": "2022-03-10T12:15:50",
            "to": "2022-03-10T12:15:50",
            "duration": "<string>",
            "period": "<string>",
            "excludes": [
              "2023-12-25"
            ],
            "type": "DAILY"
          }
        }
      ],
      "hourlyPay": 123,
      "efficiency": 123,
      "periodRules": [
        {
          "period": {
            "from": "2022-03-10T12:15:50",
            "to": "2022-03-10T12:15:50",
            "duration": "<string>",
            "period": "<string>",
            "excludes": [
              "2023-12-25"
            ],
            "type": "DAILY"
          },
          "maxWorkingDays": 123,
          "minWorkingDays": 123,
          "minWorkingDuration": "<string>",
          "maxWorkingDuration": "<string>",
          "minRestDurationBetweenShiftsSameDay": "<string>",
          "minRestDuration": "<string>",
          "maxShiftLength": "<string>",
          "minShiftLength": "<string>",
          "latestShiftStart": "<string>",
          "earliestShiftStart": "<string>",
          "latestShiftEnd": "<string>",
          "minWeekendsIdle": 123,
          "maxWeekendsIdle": 123
        }
      ],
      "constracts": [
        {
          "name": "<string>",
          "max": "<string>",
          "min": "<string>",
          "maxConsecutiveWorkDays": 123,
          "maxShiftsDay": 123,
          "minRestBetweenShiftsSameDay": 123,
          "minRest": "<string>",
          "maxWorkingDays": 123,
          "maxShiftLength": "<string>",
          "minShiftLength": "<string>",
          "latestShiftStart": "<string>",
          "earliestShiftStart": "<string>",
          "latestShiftEnd": "<string>"
        }
      ]
    }
  ],
  "shifts": [
    {
      "name": "<string>",
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "min": 123,
      "max": 123,
      "tags": [
        {
          "name": "<string>"
        }
      ],
      "skills": [
        {
          "name": "<string>",
          "hard": true,
          "weight": 123
        }
      ],
      "priority": 123,
      "cost": 123,
      "rests": [
        {
          "periodType": "DAILY",
          "tags": [
            "<string>"
          ],
          "excludes": [
            "<string>"
          ],
          "period": {
            "from": "2022-03-10T12:15:50",
            "to": "2022-03-10T12:15:50",
            "duration": "<string>",
            "period": "<string>",
            "excludes": [
              "2023-12-25"
            ],
            "type": "DAILY"
          },
          "min": "<string>",
          "minConsecutive": "<string>",
          "max": "<string>",
          "frequency": 123,
          "sequence": "BEFORE"
        }
      ],
      "blocklist": [
        "<string>"
      ],
      "value": 123,
      "employees": [
        "<string>"
      ],
      "locked": [
        true
      ],
      "location": {
        "lat": 123,
        "lon": 123
      }
    }
  ],
  "rules": [
    {
      "constraint": "COUNTER",
      "type": "HOURS_WORKED",
      "period": {
        "from": "2022-03-10T12:15:50",
        "to": "2022-03-10T12:15:50",
        "duration": "<string>",
        "period": "<string>",
        "excludes": [
          "2023-12-25"
        ],
        "type": "DAILY"
      },
      "min": 123,
      "max": 123,
      "shifts": [
        "<string>"
      ],
      "then": {}
    }
  ],
  "rests": [
    {
      "periodType": "DAILY",
      "tags": [
        "<string>"
      ],
      "excludes": [
        "<string>"
      ],
      "period": {
        "from": "2022-03-10T12:15:50",
        "to": "2022-03-10T12:15:50",
        "duration": "<string>",
        "period": "<string>",
        "excludes": [
          "2023-12-25"
        ],
        "type": "DAILY"
      },
      "min": "<string>",
      "minConsecutive": "<string>",
      "max": "<string>",
      "frequency": 123,
      "sequence": "BEFORE"
    }
  ],
  "demands": [
    {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "skills": [
        {
          "name": "<string>",
          "hard": true,
          "weight": 123
        }
      ],
      "name": "<string>",
      "min": 123,
      "max": 123
    }
  ],
  "patterns": [
    {
      "type": "SINGLE_DAY",
      "satisfy": "PREFERRED",
      "elements": [
        {
          "type": "ON",
          "tags": [
            "<string>"
          ]
        }
      ],
      "weight": 123
    }
  ],
  "fairnessBuckets": [
    {
      "employees": [
        "<string>"
      ],
      "shifts": [
        "<string>"
      ],
      "target": "<string>",
      "period": {
        "from": "2022-03-10T12:15:50",
        "to": "2022-03-10T12:15:50",
        "duration": "<string>",
        "period": "<string>",
        "excludes": [
          "2023-12-25"
        ],
        "type": "DAILY"
      }
    }
  ],
  "requirements": [
    {
      "shifts": [
        "<string>"
      ],
      "skill": "<string>",
      "value": 123
    }
  ],
  "assignments": [
    {
      "shift": "<string>",
      "employee": "<string>",
      "locked": true
    }
  ],
  "weights": {
    "unassigned": "<string>",
    "maxWorkingDays": "<string>",
    "concurrent": "<string>",
    "sameDay": "<string>",
    "minRest": "<string>",
    "maxConsecutive": "<string>",
    "working": "<string>",
    "sameDayMinRest": "<string>",
    "minHours": "<string>",
    "minHoursUnassigned": "<string>",
    "maxHours": "<string>",
    "minShift": "<string>",
    "maxShift": "<string>",
    "shiftStart": "<string>",
    "latestShiftStart": "<string>",
    "shiftEnd": "<string>",
    "dayOfWeek": "<string>",
    "requirements": "<string>",
    "availability": "<string>",
    "skills": "<string>",
    "criticalSkills": "<string>",
    "locked": "<string>",
    "blacklist": "<string>",
    "pref": "<string>",
    "costs": "<string>",
    "wages": "<string>",
    "efficiency": "<string>",
    "distance": "<string>",
    "distanceAL": "<string>",
    "priority": "<string>",
    "softSkills": "<string>",
    "softSkillsLevel": "<string>",
    "fairness": "<string>"
  },
  "options": {
    "hardAvailability": true,
    "hardSkill": true,
    "hardBlacklist": true,
    "partialPlanning": true,
    "penaliseZeroHours": true,
    "useAvailabilityLocations": true,
    "alwaysScoreSharedSkills": true,
    "explanation": {
      "enabled": true,
      "filterHardConstraints": true
    },
    "idleWeekend": {
      "fromDayOfWeek": "MONDAY",
      "fromTime": "<string>",
      "toDayOfWeek": "MONDAY",
      "toTime": "<string>",
      "restTime": "<string>"
    }
  },
  "hook": "<string>",
  "label": "<string>"
}
'

{
  "id": "<string>",
  "status": "QUEUED",
  "solveDuration": 123,
  "errors": [
    {
      "message": "<string>",
      "code": 123
    }
  ],
  "warnings": [
    {
      "message": "<string>",
      "code": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

Api Key based authentication (apikey)

Body

application/json

FILL request for solving, evaluating

employees

employees · object[]

required

List of employees

Minimum array length: 1

Show child attributes

employees.name

string

required

Name of the employee (unique)

employees.home

object

Home location of the employee. The solver will then optimize total travel time. Location

Show child attributes

employees.home.lat

number<double>

latitude of the location

employees.home.lon

number<double>

longitude of the location

employees.availability

object[] | null

Availability of the employee

Show child attributes

employees.availability.from

string<date-time>

required

start time of the window

employees.availability.to

string<date-time>

required

end time of the window

employees.availability.location

object

location of the window Location

Show child attributes

employees.availability.location.lat

number<double>

latitude of the location

employees.availability.location.lon

number<double>

longitude of the location

employees.preference

string[] | null

Shift preferences of the employee. List of shift tags.

employees.skills

object[] | null

Skills of the employee

Show child attributes

employees.skills.name

string

required

name of the skill

employees.skills.expiry

string<date> | null

expiry date of the skill

Example:

"2022-03-10"

employees.skills.weight

integer<int32> | null

weight of the skill

employees.skills.period

object

Period

Show child attributes

employees.skills.period.from

string<date-time> | null

Start of the period

Example:

"2022-03-10T12:15:50"

employees.skills.period.to

string<date-time> | null

End of the period

Example:

"2022-03-10T12:15:50"

employees.skills.period.duration

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

employees.skills.period.period

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

employees.skills.period.excludes

string<date>[] | null

List of dates to exclude from the from/to period.

employees.skills.period.type

enum<string> | null

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

employees.hourlyPay

number<double> | null

Hourly pay of the employee. The solver will then optimize the cost of the planning.

employees.efficiency

number<double> | null

Efficiency of the employee

employees.periodRules

object[] | null

Rules that hold for the entire period.

Show child attributes

employees.periodRules.period

object

required

Period of the rule. The rule only applies to this period

Show child attributes

employees.periodRules.period.from

string<date-time> | null

Start of the period

Example:

"2022-03-10T12:15:50"

employees.periodRules.period.to

string<date-time> | null

End of the period

Example:

"2022-03-10T12:15:50"

employees.periodRules.period.duration

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

employees.periodRules.period.period

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

employees.periodRules.period.excludes

string<date>[] | null

List of dates to exclude from the from/to period.

employees.periodRules.period.type

enum<string> | null

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

employees.periodRules.maxWorkingDays

integer<int32> | null

Maximum number of working days in the period.

employees.periodRules.minWorkingDays

integer<int32> | null

Minimum number of working days in the period.

employees.periodRules.minWorkingDuration

string<> | null

Minimum working duration in the period. Not including travel time

employees.periodRules.maxWorkingDuration

string<> | null

Maximum working duration in the period. Not including travel time

employees.periodRules.minRestDurationBetweenShiftsSameDay

string<> | null

Minimum rest duration between shifts in the same day

employees.periodRules.minRestDuration

string<> | null

Minimum rest duration between shifts

employees.periodRules.maxShiftLength

string<> | null

maximum shift length

employees.periodRules.minShiftLength

string<> | null

minimum shift length

employees.periodRules.latestShiftStart

string<> | null

latest shift start

employees.periodRules.earliestShiftStart

string<> | null

earliest shift start

employees.periodRules.latestShiftEnd

string<> | null

latest shift end

employees.periodRules.minWeekendsIdle

integer<int32> | null

The minimum number of weekends to be idle in this period.

employees.periodRules.maxWeekendsIdle

integer<int32> | null

The maximum number of weekends to be idle in this period.

employees.constracts

object[] | null

Show child attributes

employees.constracts.name

string | null

required

name of the contract

employees.constracts.max

string<> | null

maximum working time per week

employees.constracts.min

string<> | null

minimum working time per week

employees.constracts.maxConsecutiveWorkDays

integer<int32> | null

maximum consecutive work days

employees.constracts.maxShiftsDay

integer<int32> | null

maximum shifts per day

employees.constracts.minRestBetweenShiftsSameDay

integer<int32> | null

minimum rest between shifts on the same day

employees.constracts.minRest

string<> | null

minimum rest between shifts

employees.constracts.maxWorkingDays

integer<int32> | null

maximum working days per week

employees.constracts.maxShiftLength

string<> | null

maximum shift length

employees.constracts.minShiftLength

string<> | null

minimum shift length

employees.constracts.latestShiftStart

string<> | null

latest shift start

employees.constracts.earliestShiftStart

string<> | null

earliest shift start

employees.constracts.latestShiftEnd

string<> | null

latest shift end

shifts

object[]

required

List of shifts that should be assigned to employees

Minimum array length: 1

Show child attributes

shifts.name

string

required

Name of the shift

shifts.from

string<date-time>

required

Start time of the shift

shifts.to

string<date-time>

required

End time of the shift

shifts.min

integer<int32> | null

required

Minimum number of employees assigned to this shift.

shifts.max

integer<int32> | null

required

Maximum number of employees assigned to this shift.

shifts.tags

object[] | null

Shift tags. Used to identify groups of shifts in rules.

Show child attributes

shifts.tags.name

string

required

shifts.skills

object[] | null

Skills required for the shift

Show child attributes

shifts.skills.name

string

required

name of the skill

shifts.skills.hard

boolean | null

Hard requirement or not. If not, the skill is a soft skill requirement that will act as an affinity.

shifts.skills.weight

integer<int32> | null

weight of the skill

shifts.priority

integer<int64> | null

Priority of the shift. High priority shifts get assigned more

shifts.cost

integer<int64> | null

Financial cost of the shift

shifts.rests

object[] | null

Shift rests can define required idle/rest time after the shift.

Show child attributes

shifts.rests.periodType

enum<string> | null

Rest type (CONSECUTIVE or WEEKLY)

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

shifts.rests.tags

string[] | null

Filter by shift tag

shifts.rests.excludes

string[] | null

Filter by shift tag excludes

shifts.rests.period

object

Planning Period Period

Show child attributes

shifts.rests.period.from

string<date-time> | null

Start of the period

Example:

"2022-03-10T12:15:50"

shifts.rests.period.to

string<date-time> | null

End of the period

Example:

"2022-03-10T12:15:50"

shifts.rests.period.duration

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

shifts.rests.period.period

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

shifts.rests.period.excludes

string<date>[] | null

List of dates to exclude from the from/to period.

shifts.rests.period.type

enum<string> | null

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

shifts.rests.min

string<> | null

Minimum duration

shifts.rests.minConsecutive

string<> | null

Minimum consecutive duration of a rest.

shifts.rests.max

string<> | null

Maximum duration

shifts.rests.frequency

integer<int32> | null

Maximum number of rest periods

shifts.rests.sequence

enum<string> | null

If the rest needs to be BEFORE or AFTER a shift (tags must be applied as well)

Available options:

BEFORE,

AFTER

shifts.blocklist

string[] | null

Maximum number of employees assigned to this shift.

shifts.value

integer<int32> | null

shifts.employees

string[] | null

shifts.locked

boolean[] | null

shifts.location

object

Location

Show child attributes

shifts.location.lat

number<double>

latitude of the location

shifts.location.lon

number<double>

longitude of the location

rules

object[] | null

List of Rules. Rules can be Counters or Series.

Show child attributes

rules.constraint

enum<string>

required

Type of constraint. COUNTER or SEQUENCE. A counter counts the number of occurances and the constraint

Available options:

COUNTER,

SEQUENCE

rules.type

enum<string>

required

Type of rule. HOURS_WORKED, DAYS_WORKED, DAYS_IDLE, WEEKENDS_WORKED, WEEKENDS_IDLE, SHIFT_TYPES_WORKED or SHIFT_TYPES_HOURS_WORKED

Available options:

HOURS_WORKED,

DAYS_WORKED,

DAYS_IDLE,

WEEKENDS_WORKED,

WEEKENDS_IDLE,

SHIFT_TYPES_WORKED,

SHIFT_TYPES_HOURS_WORKED

rules.period

object

Period for which this rule holds Period

Show child attributes

rules.period.from

string<date-time> | null

Start of the period

Example:

"2022-03-10T12:15:50"

rules.period.to

string<date-time> | null

End of the period

Example:

"2022-03-10T12:15:50"

rules.period.duration

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

rules.period.period

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

rules.period.excludes

string<date>[] | null

List of dates to exclude from the from/to period.

rules.period.type

enum<string> | null

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

rules.min

integer<int32> | null

Minimum number of employees necessary to fill these shifts.

rules.max

integer<int32> | null

Maximum number of employees necessary to fill these shifts. If min==max then you'll get that exact amount of employees.

rules.shifts

string[] | null

Shift tags to filter this rule by. For example only shifts with the tag EARLY.

rules.then

object

Period rule. Consequence of this rule.

rests

object[] | null

List of Rest definitions. A rest is defined for a fixed period or a duration.

Show child attributes

rests.periodType

enum<string> | null

Rest type (CONSECUTIVE or WEEKLY)

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

rests.tags

string[] | null

Filter by shift tag

rests.excludes

string[] | null

Filter by shift tag excludes

rests.period

object

Planning Period Period

Show child attributes

rests.period.from

string<date-time> | null

Start of the period

Example:

"2022-03-10T12:15:50"

rests.period.to

string<date-time> | null

End of the period

Example:

"2022-03-10T12:15:50"

rests.period.duration

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

rests.period.period

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

rests.period.excludes

string<date>[] | null

List of dates to exclude from the from/to period.

rests.period.type

enum<string> | null

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

rests.min

string<> | null

Minimum duration

rests.minConsecutive

string<> | null

Minimum consecutive duration of a rest.

rests.max

string<> | null

Maximum duration

rests.frequency

integer<int32> | null

Maximum number of rest periods

rests.sequence

enum<string> | null

If the rest needs to be BEFORE or AFTER a shift (tags must be applied as well)

Available options:

BEFORE,

AFTER

demands

object[] | null

List of shift demands. Demands are periodic minima and maxima for a certain number of employees to be present.

Show child attributes

demands.from

string<date-time>

required

The start time of the shift demand

demands.to

string<date-time>

required

The end time of the shift demand

demands.skills

object[] | null

required

The skills required for the shift demand

Show child attributes

demands.skills.name

string

required

name of the skill

demands.skills.hard

boolean | null

Hard requirement or not. If not, the skill is a soft skill requirement that will act as an affinity.

demands.skills.weight

integer<int32> | null

weight of the skill

demands.name

string

required

demands.min

integer<int64> | null

The minimum number of shifts to create

demands.max

integer<int64> | null

The maximum number of shifts to create

patterns

object[] | null

List of shift patterns. Patterns are sequences of shifts that can be desired or prohibited.

Show child attributes

patterns.type

enum<string> | null

SINGLE_DAY (spanning shifts in a single days) or MULTI_DAY (spanning shifts accross days)

Available options:

SINGLE_DAY,

MULTI_DAY

patterns.satisfy

enum<string> | null

(PREFERRED, PROHIBITED, or UNPREFERRED)

Available options:

PREFERRED,

PROHIBITED,

UNPREFERRED

patterns.elements

object[] | null

List of Pattern Elements describing ON/OFF for several shifts

Show child attributes

patterns.elements.type

enum<string> | null

ON (doing that shift) or OFF (not doing that shift)

Available options:

ON,

OFF

patterns.elements.tags

string[] | null

List of shift tags to include

patterns.weight

integer<int32> | null

Importance (weight) of the Pattern

fairnessBuckets

object[] | null

Buckets or groups of employees where fairness in workload is required.

Show child attributes

fairnessBuckets.employees

string[]

required

The employees in the fairness bucket

fairnessBuckets.shifts

string[]

required

The shifts in the fairness bucket

fairnessBuckets.target

string<>

required

The target value of workload per employee

fairnessBuckets.period

object

The period over which the fairness bucket applies. Default is over the entire planning period. Period

Show child attributes

fairnessBuckets.period.from

string<date-time> | null

Start of the period

Example:

"2022-03-10T12:15:50"

fairnessBuckets.period.to

string<date-time> | null

End of the period

Example:

"2022-03-10T12:15:50"

fairnessBuckets.period.duration

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

fairnessBuckets.period.period

string<> | null

Duration of the rolling period in ISO8601 format (e.g. P1D). Do not use this in combo with from/to

fairnessBuckets.period.excludes

string<date>[] | null

List of dates to exclude from the from/to period.

fairnessBuckets.period.type

enum<string> | null

Available options:

DAILY,

WEEKLY,

MONTHLY,

SCHEDULE

requirements

object[] | null

List of shared skill requirements. Shared skills are skill requirements that govern a group of shifts.

Show child attributes

requirements.shifts

string[]

required

List of shifts that the requirement applies to

requirements.skill

string

required

The skill this requirement applies to

requirements.value

integer<int32>

required

The number of shared resources required for this skill.

assignments

object[] | null

List of assignments that are pre-set. (optional)

Show child attributes

assignments.shift

string

required

Name of the shift

assignments.employee

string

required

Name of the employee

assignments.locked

boolean

If the shift is locked. Locked shifts cannot be touched by the solver

weights

object

Weights adjust objectives and scores.

Show child attributes

weights.unassigned

string | null

weights.maxWorkingDays

string | null

weights.concurrent

string | null

weights.sameDay

string | null

weights.minRest

string | null

weights.maxConsecutive

string | null

weights.working

string | null

weights.sameDayMinRest

string | null

weights.minHours

string | null

weights.minHoursUnassigned

string | null

weights.maxHours

string | null

weights.minShift

string | null

weights.maxShift

string | null

weights.shiftStart

string | null

weights.latestShiftStart

string | null

weights.shiftEnd

string | null

weights.dayOfWeek

string | null

weights.requirements

string | null

weights.availability

string | null

weights.skills

string | null

weights.criticalSkills

string | null

weights.locked

string | null

weights.blacklist

string | null

weights.pref

string | null

weights.costs

string | null

weights.wages

string | null

weights.efficiency

string | null

weights.distance

string | null

weights.distanceAL

string | null

weights.priority

string | null

weights.softSkills

string | null

weights.softSkillsLevel

string | null

weights.fairness

string | null

options

object

Options for tuning the solver

Show child attributes

options.hardAvailability

boolean | null

Whether to enforce availability constraints

options.hardSkill

boolean | null

Whether to enforce skill constraints

options.hardBlacklist

boolean | null

Whether to enforce blacklist constraints

options.partialPlanning

boolean | null

Partial planning. Whether to fill all shifts or not. Default is false

options.penaliseZeroHours

boolean | null

Whether to penalise employees with zero hours

options.useAvailabilityLocations

boolean | null

Whether to use availability locations

options.alwaysScoreSharedSkills

boolean | null

Whether to always score shared skills

options.explanation

object

Explanation options. Explanation

Show child attributes

options.explanation.enabled

boolean | null

Whether to enable post-processing of explainability

options.explanation.filterHardConstraints

boolean | null

Whether to filter hard constraint violated solutions in the response.

options.idleWeekend

object

Idle weekend definition.

Show child attributes

options.idleWeekend.fromDayOfWeek

enum<string>

required

Day of the week on which the weekend officially starts.

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

options.idleWeekend.fromTime

string<>

required

Time of day on which the weekend officially starts.

options.idleWeekend.toDayOfWeek

enum<string>

required

Day of the week on which the weekend officially ends.

Available options:

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY,

SUNDAY

options.idleWeekend.toTime

string<>

required

Time of day on which the weekend officially ends.

options.idleWeekend.restTime

string<> | null

hook

string<uri> | null

Webhook endpoint to receive POST request with the id.

label

string | null

Response

Status of a solve job

string

required

Job ID

status

enum<string> | null

Status of the solve.

Available options:

QUEUED,

SOLVING,

SOLVED,

ERROR

solveDuration

integer<int32> | null

Duration of the solve in seconds

errors

object[] | null

List of errors

Show child attributes

errors.message

string

required

Error message

errors.code

integer<int32>

Error code

warnings

object[] | null

List of warnings

Show child attributes

warnings.message

string

required

Error message

warnings.code

integer<int32>

Error code

Fill Explanation

⌘I

Solve

curl --request POST \
  --url https://api.solvice.io/v2/fill/solve \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employees": [
    {
      "name": "<string>",
      "home": {
        "lat": 123,
        "lon": 123
      },
      "availability": [
        {
          "from": "2023-11-07T05:31:56Z",
          "to": "2023-11-07T05:31:56Z",
          "location": {
            "lat": 123,
            "lon": 123
          }
        }
      ],
      "preference": [
        "<string>"
      ],
      "skills": [
        {
          "name": "<string>",
          "expiry": "2022-03-10",
          "weight": 123,
          "period": {
            "from": "2022-03-10T12:15:50",
            "to": "2022-03-10T12:15:50",
            "duration": "<string>",
            "period": "<string>",
            "excludes": [
              "2023-12-25"
            ],
            "type": "DAILY"
          }
        }
      ],
      "hourlyPay": 123,
      "efficiency": 123,
      "periodRules": [
        {
          "period": {
            "from": "2022-03-10T12:15:50",
            "to": "2022-03-10T12:15:50",
            "duration": "<string>",
            "period": "<string>",
            "excludes": [
              "2023-12-25"
            ],
            "type": "DAILY"
          },
          "maxWorkingDays": 123,
          "minWorkingDays": 123,
          "minWorkingDuration": "<string>",
          "maxWorkingDuration": "<string>",
          "minRestDurationBetweenShiftsSameDay": "<string>",
          "minRestDuration": "<string>",
          "maxShiftLength": "<string>",
          "minShiftLength": "<string>",
          "latestShiftStart": "<string>",
          "earliestShiftStart": "<string>",
          "latestShiftEnd": "<string>",
          "minWeekendsIdle": 123,
          "maxWeekendsIdle": 123
        }
      ],
      "constracts": [
        {
          "name": "<string>",
          "max": "<string>",
          "min": "<string>",
          "maxConsecutiveWorkDays": 123,
          "maxShiftsDay": 123,
          "minRestBetweenShiftsSameDay": 123,
          "minRest": "<string>",
          "maxWorkingDays": 123,
          "maxShiftLength": "<string>",
          "minShiftLength": "<string>",
          "latestShiftStart": "<string>",
          "earliestShiftStart": "<string>",
          "latestShiftEnd": "<string>"
        }
      ]
    }
  ],
  "shifts": [
    {
      "name": "<string>",
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "min": 123,
      "max": 123,
      "tags": [
        {
          "name": "<string>"
        }
      ],
      "skills": [
        {
          "name": "<string>",
          "hard": true,
          "weight": 123
        }
      ],
      "priority": 123,
      "cost": 123,
      "rests": [
        {
          "periodType": "DAILY",
          "tags": [
            "<string>"
          ],
          "excludes": [
            "<string>"
          ],
          "period": {
            "from": "2022-03-10T12:15:50",
            "to": "2022-03-10T12:15:50",
            "duration": "<string>",
            "period": "<string>",
            "excludes": [
              "2023-12-25"
            ],
            "type": "DAILY"
          },
          "min": "<string>",
          "minConsecutive": "<string>",
          "max": "<string>",
          "frequency": 123,
          "sequence": "BEFORE"
        }
      ],
      "blocklist": [
        "<string>"
      ],
      "value": 123,
      "employees": [
        "<string>"
      ],
      "locked": [
        true
      ],
      "location": {
        "lat": 123,
        "lon": 123
      }
    }
  ],
  "rules": [
    {
      "constraint": "COUNTER",
      "type": "HOURS_WORKED",
      "period": {
        "from": "2022-03-10T12:15:50",
        "to": "2022-03-10T12:15:50",
        "duration": "<string>",
        "period": "<string>",
        "excludes": [
          "2023-12-25"
        ],
        "type": "DAILY"
      },
      "min": 123,
      "max": 123,
      "shifts": [
        "<string>"
      ],
      "then": {}
    }
  ],
  "rests": [
    {
      "periodType": "DAILY",
      "tags": [
        "<string>"
      ],
      "excludes": [
        "<string>"
      ],
      "period": {
        "from": "2022-03-10T12:15:50",
        "to": "2022-03-10T12:15:50",
        "duration": "<string>",
        "period": "<string>",
        "excludes": [
          "2023-12-25"
        ],
        "type": "DAILY"
      },
      "min": "<string>",
      "minConsecutive": "<string>",
      "max": "<string>",
      "frequency": 123,
      "sequence": "BEFORE"
    }
  ],
  "demands": [
    {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "skills": [
        {
          "name": "<string>",
          "hard": true,
          "weight": 123
        }
      ],
      "name": "<string>",
      "min": 123,
      "max": 123
    }
  ],
  "patterns": [
    {
      "type": "SINGLE_DAY",
      "satisfy": "PREFERRED",
      "elements": [
        {
          "type": "ON",
          "tags": [
            "<string>"
          ]
        }
      ],
      "weight": 123
    }
  ],
  "fairnessBuckets": [
    {
      "employees": [
        "<string>"
      ],
      "shifts": [
        "<string>"
      ],
      "target": "<string>",
      "period": {
        "from": "2022-03-10T12:15:50",
        "to": "2022-03-10T12:15:50",
        "duration": "<string>",
        "period": "<string>",
        "excludes": [
          "2023-12-25"
        ],
        "type": "DAILY"
      }
    }
  ],
  "requirements": [
    {
      "shifts": [
        "<string>"
      ],
      "skill": "<string>",
      "value": 123
    }
  ],
  "assignments": [
    {
      "shift": "<string>",
      "employee": "<string>",
      "locked": true
    }
  ],
  "weights": {
    "unassigned": "<string>",
    "maxWorkingDays": "<string>",
    "concurrent": "<string>",
    "sameDay": "<string>",
    "minRest": "<string>",
    "maxConsecutive": "<string>",
    "working": "<string>",
    "sameDayMinRest": "<string>",
    "minHours": "<string>",
    "minHoursUnassigned": "<string>",
    "maxHours": "<string>",
    "minShift": "<string>",
    "maxShift": "<string>",
    "shiftStart": "<string>",
    "latestShiftStart": "<string>",
    "shiftEnd": "<string>",
    "dayOfWeek": "<string>",
    "requirements": "<string>",
    "availability": "<string>",
    "skills": "<string>",
    "criticalSkills": "<string>",
    "locked": "<string>",
    "blacklist": "<string>",
    "pref": "<string>",
    "costs": "<string>",
    "wages": "<string>",
    "efficiency": "<string>",
    "distance": "<string>",
    "distanceAL": "<string>",
    "priority": "<string>",
    "softSkills": "<string>",
    "softSkillsLevel": "<string>",
    "fairness": "<string>"
  },
  "options": {
    "hardAvailability": true,
    "hardSkill": true,
    "hardBlacklist": true,
    "partialPlanning": true,
    "penaliseZeroHours": true,
    "useAvailabilityLocations": true,
    "alwaysScoreSharedSkills": true,
    "explanation": {
      "enabled": true,
      "filterHardConstraints": true
    },
    "idleWeekend": {
      "fromDayOfWeek": "MONDAY",
      "fromTime": "<string>",
      "toDayOfWeek": "MONDAY",
      "toTime": "<string>",
      "restTime": "<string>"
    }
  },
  "hook": "<string>",
  "label": "<string>"
}
'

{
  "id": "<string>",
  "status": "QUEUED",
  "solveDuration": 123,
  "errors": [
    {
      "message": "<string>",
      "code": 123
    }
  ],
  "warnings": [
    {
      "message": "<string>",
      "code": 123
    }
  ]
}

VRP API

Fill API

Authorizations

Body

Response