v1/shift_rotation_groups/{id}/assign_employee

post

https://shyftplan.com/api/v1/shift_rotation_groups/{id}/assign_employee

Assign an employee to a shift-system group.

Path Params

string

required

ID of the shift-system group.

Body Params

user_email

string

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.

company_id

int32

required

≥ 1

ID of a shyftplan account.

conflict_check_only

boolean

Defaults to false

employment_id

int32

required

≥ 1

ID of the employment.

ignore_warning_conflicts

boolean

Defaults to false

locations_position_id

int32

required

≥ 1

ID of a locations-position, which is the link between a position and a location. (These IDs are returned by GET /locations_positions.)

shiftplan_id

int32

≥ 1

ID of the shift schedule.

start_date

date-time

Date-time (ISO 8601) for the begin of the object's span.

end_date

date-time

required

Date-time (ISO 8601) for the end of the object's span.

shiftplan_frames

array of objects

shiftplan_frames

unassign_conflicting_shifts

boolean

Defaults to false

Responses

201Assignment was successfully started

401Unauthorized

403forbidden

404Couldn't find ShiftSystemGroup\nCouldn't find LocationsPosition

422Invalid start_date or end_date