Skip to content
Bottle

Design a shift pattern

POST
/shift-patterns
curl --request POST \
  --url https://example.com/shift-patterns \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "name": "example", "colour": "example", "cycleWeeks": 1, "days": [ { "week": 1, "weekday": 1, "start": "07:30", "end": "07:30" } ], "breakMinutes": 1 }'

The working days of a cycle of one to four weeks, each with its hours. Days in weeks past the cycle are dropped.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
colour
string | null
/^#[0-9A-Fa-f]{6}$/
cycleWeeks
integer
default: 1 >= 1 <= 4
days
required
Array<object>
<= 28 items
object
week
required
integer
<= 3
weekday
required
integer
>= 1 <= 7
start
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
Example
07:30
end
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
Example
07:30
breakMinutes
integer | null
<= 240

Responses

Section titled “Responses”

201

Section titled “201”

Made

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
colour
required
string | null
cycleWeeks
required
integer
>= 1 <= 4
days
required
Array<object>
object
week
required
integer
<= 3
weekday
required
integer
>= 1 <= 7
start
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
breakMinutes
required
integer | null
<= 240
driverUserIds
required
Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "days": [
    {
      "start": "07:30",
      "end": "07:30"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}