v1/shift_rotations/{id}/shiftplan

post

https://shyftplan.com/api/v1/shift_rotations/{id}/shiftplan

Create a shift schedule with a shift system already applied to it - shifts are automatically inserted into the newly created schedule, according to the shift system specified.

Path Params

int32

required

ID of the shift system.

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.

ends_at

date

required

End Date of the Shiftplan

location_id

int32

required

ID of an Location

metadata

string

Shiftplan metadata as json

name

string

required

Name of the Shiftplan

starts_at

date

required

Start Date of the Shiftplan

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

201{ id: 1, job_id: 1 }

401Unauthorized

403Forbidden

404Company not found\nLocation not found\nShift system not found\nworkers_per_positions_list[][id] not found

422Invalid request