v1/shiftplans/{id}/assign_rotation

post

https://shyftplan.com/api/v1/shiftplans/{id}/assign_rotation

Apply a shift system to an existing shiftplan. Operation happens in background

Path Params

int32

required

Shiftplan ID.

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.

company_id

int32

required

≥ 1

ID of a shyftplan account.

shift_rotation_id

int32

required

ID of a shift system.

workers_per_positions_list

array of objects

required

workers_per_positions_list*

is_exclude_special_days_enabled

boolean

Defaults to false

Exclude special dates

is_include_start_on_special_days_enabled

boolean

Defaults to false

Include shifts that start on special dates

is_include_end_on_special_days_enabled

boolean

Defaults to false

Include shifts that end on special dates

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201{ success: true }

403forbidden

404Company not found

422Shiftplan is locked