Create a shift

POST 
/api/v1/shifts

Create a shift.

Request

Header Parameters

idempotency-key string

application/json

Body

required

data objectrequired
attributes objectrequired
externalFacilityId stringrequired
shifts object[]required
Array [
shiftLabel stringrequired
workerRequirements stringrequired
Accepts CNA, LVN, RN, CAREGIVER, NURSE, and Medication Aide
startTime date-timerequired
endTime date-timerequired
assignedTo object
externalUserId stringrequired
firstName stringrequired
lastName stringrequired
email string
phone string
workerType object
Accepts CNA, LVN, RN, CAREGIVER, Medication Aide
]
type stringrequired

Responses

200

application/json

Schema

Schema

data object[]required
Array [
attributes objectrequired
externalFacilityId stringrequired
startTime date-timerequired
endTime date-timerequired
shiftLabel stringrequired
workerRequirements stringrequired
Accepts CNA, LVN, RN, CAREGIVER, NURSE, and Medication Aide
createdAt date-timerequired
id stringrequired
type stringrequired
relationships objectrequired
assignment objectrequired
id stringrequired
type stringrequired
facilityUnit objectrequired
id stringrequired
type stringrequired
]

Example (from schema)

{
  "data": [
    {
      "attributes": {
        "externalFacilityId": "string",
        "startTime": "2024-10-18T18:11:52.919Z",
        "endTime": "2024-10-18T18:11:52.919Z",
        "shiftLabel": "string",
        "workerRequirements": "string",
        "createdAt": "2024-10-18T18:11:52.919Z"
      },
      "id": "string",
      "type": "string",
      "relationships": {
        "assignment": {
          "id": "string",
          "type": "string"
        },
        "facilityUnit": {
          "id": "string",
          "type": "string"
        }
      }
    }
  ]
}

4XX

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
id stringrequired
status stringrequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "status": "string",
      "title": "string"
    }
  ]
}

5XX

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
id stringrequired
status stringrequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "status": "string",
      "title": "string"
    }
  ]
}

Loading...