v1/staff_shifts/replace

post

https://shyftplan.com/api/v1/staff_shifts/replace

Replace one employee with another on shift

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

employment_id

int32

required

ID of an Employment being assigned to shift

shift_id

int32

required

ID of Shift to which staff is being assigned

source_employment_id

int32

required

ID of the Employment that is being removed from shift

ignore_conflicts

string

Defaults to false

Either true to ignore all conflicts listed below or an Array of specific conflicts to ignore. Only warnings can be ignored, enforced conflicts will persist. Possible values are:

shifts_collision
absences_collision
locations_position_changed
minimum_break
maximum_working_hours
minimum_rest
maximum_earning
outside_employment_period
maximum_consecutive_working_days
restricted_shift_presets
unavailable
not_available
minimum_qualification_level
not_in_shift_preset
punch_timing_reassignment

metadata

string

StaffShift metadata as json

unassign_conflicting_shifts

boolean

Defaults to false

Remove the Employment from the shifts it collides with. Only possible when every conflicting shift can be unassigned and shifts_collision conflicts are ignored.

Responses

201Successfully replaced staff on shift

403Forbidden

404Company not found, Shift not found, Employment cannot be blank, Source Employemnt not found

422Unable to add Employment