Employee Shift

The employee shift resource.

Basehttps://rest.carbon.ms/employeeShift

GET/employeeShift

List employee shifts

Retrieve a paginated list of employee shifts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/employeeShift

curl --request GET \
  --url 'https://rest.carbon.ms/employeeShift?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "employeeId": "xyz789",
    "shiftId": "xyz789"
  }
]

GET/employeeShift

Retrieve a employee shift

Fetch a single employee shift by filtering on `id`.

Query parameters

idstring

Match on the employee shift's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/employeeShift

curl --request GET \
  --url 'https://rest.carbon.ms/employeeShift?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "employeeId": "xyz789",
  "shiftId": "xyz789"
}

POST/employeeShift

Create a employee shift

Create a new employee shift.

Body parameters

employeeIdstringrequired

References user.id

shiftIdstringrequired

References shift.id

POSThttps://rest.carbon.ms/employeeShift

curl --request POST \
  --url https://rest.carbon.ms/employeeShift \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"employeeId":"xyz789","shiftId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "employeeId": "xyz789",
  "shiftId": "xyz789"
}

PATCH/employeeShift

Update a employee shift

Update an existing employee shift, matched on `id`.

Body parameters

employeeIdstringrequired

References user.id

shiftIdstringrequired

References shift.id

PATCHhttps://rest.carbon.ms/employeeShift

curl --request PATCH \
  --url 'https://rest.carbon.ms/employeeShift?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"employeeId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "employeeId": "xyz789",
  "shiftId": "xyz789"
}

DELETE/employeeShift

Delete a employee shift

Delete a employee shift, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the employee shift to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/employeeShift

curl --request DELETE \
  --url 'https://rest.carbon.ms/employeeShift?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content