Create base shift

post

{backendUrlScheme}://{backendUrlHost}/api/public/base-shift/create

This endpoint can be used to create a base shift. In the request you provide a session ID in the header and base shift details in the body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

userId

string

required

User ID

startDate

number

required

Base shift start date/time in milliseconds

duration

number

required

Base shift duration in milliseconds

shiftTemplateId

string

required

Shift template ID

shiftPlanningConfigId

string

Shift planning config ID

archived

boolean

Defaults to false

Whether the base shift is archived

endType

string

Base shift recurrence end type

endDate

number

Recurrence end date in milliseconds

interval

number

Recurrence interval

weekStart

number

Week start day

recurrencyRule

string

Recurrence rule

frequency

string

Recurrence frequency

count

number

Recurrence occurrence count

byWeekDay

array

Recurrence by weekday

byWeekDay

byMonth

array of numbers

Recurrence by month

byMonth

bySetPos

array of numbers

Recurrence by set position

bySetPos

byMonthDay

array of numbers

Recurrence by month day

byMonthDay

byWeekNumber

array of numbers

Recurrence by week number

byWeekNumber

Headers

bsy-sid

string

required

Session ID

Responses

Language

URL

Loading…

Response

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

application/json

200Base shift created successfully

400Bad request, invalid base shift details

401Unauthorized access, invalid or missing session ID