Get a shift

GET 
/api/v1/shifts/:shiftId

Get a shift.

Request

Path Parameters

shiftId stringrequired

Responses

200

application/json

Schema

Schema

data objectrequired
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
included object[]required
Array [
attributes objectrequired
name stringrequired
id stringrequired
type stringrequired
]

Example (from schema)

{
  "data": {
    "attributes": {
      "externalFacilityId": "string",
      "startTime": "2024-10-18T18:11:52.920Z",
      "endTime": "2024-10-18T18:11:52.920Z",
      "shiftLabel": "string",
      "workerRequirements": "string",
      "createdAt": "2024-10-18T18:11:52.920Z"
    },
    "id": "string",
    "type": "string",
    "relationships": {
      "assignment": {
        "id": "string",
        "type": "string"
      },
      "facilityUnit": {
        "id": "string",
        "type": "string"
      }
    }
  },
  "included": [
    {
      "attributes": {
        "name": "string"
      },
      "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...