Shift Scheduling

The shift schedule has simple operations for scheduling who is working when and in which unit

Create Shift

curl -i -X POST "https://example.ziik.io/api/shifts"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 201 Created

{
  "data": {
    "id": 1,
    "type": "shift",
    "start": 1540857600,
    "end": 1540861200,
    "note": null,
    "comment": null,
    "break": null,
    "open_for_trade": false,
    "corrected_working_hours_start": null,
    "corrected_working_hours_end": null,
    "corrected_working_hours_note": null,
    "unit_id": 2,
    "assignee_id": 3,
    "unit": {
      "content_type": "unit",
      "id": 2,
      "name": "Wyman, Beer and Hane",
      "level": 1,
      "unit_type": "unit",
      "url": "api/units/2"
    },
    "assignee": {
      "content_type": "user",
      "id": 3,
      "name": "Caleigh Breitenberg",
      "first_name": "Caleigh",
      "last_name": "Breitenberg",
      "title": "Postal Service Clerk",
      "avatar": null,
      "active": true,
      "unit": {
        "content_type": "unit",
        "id": 1,
        "name": "HQ",
        "level": 0,
        "unit_type": "unit",
        "url": "api/units/1"
      },
      "url": "api/users/3"
    },
    "applicants": [],
    "permissions": {
      "edit": false,
      "delete": false,
      "take": false,
      "request": false,
      "close": false,
      "apply": false,
      "approve": false
    }
  }
}

This endpoint creates a shift.

HTTP Request

POST https://example.ziik.io/api/shifts

Request Parameters

Parameter	Type	Required	Description
unit_id	Integer	Yes	Id of unit to create shift in
assignee_id	Integer	No	User ID of shift assignee
start	Integer	Yes	Unix timestamp of when the shift begins
end	Integer	Yes	Unix timestamp of when the shift ends
note	String	No	Private note only available to planners
comment	String	No	Public note available to everyone with permission to view shifts
break	Integer	No	Break in minutes

Permissions Required

• Schedule permission to units and shift's unit equal to user's unit or below

Get registrations

Registrations covers both shifts and vacations.

curl "https://example.ziik.io/api/registrations"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"

{
  "data": [
    {
      "id": 1,
      "type": "shift",
      "start": 1540857600,
      "end": 1540861200,
      "note": null,
      "comment": null,
      "break": null,
      "open_for_trade": false,
      "corrected_working_hours_start": null,
      "corrected_working_hours_end": null,
      "corrected_working_hours_note": null,
      "unit_id": 2,
      "assignee_id": 3,
      "unit": {
        "content_type": "unit",
        "id": 2,
        "name": "Wyman, Beer and Hane",
        "level": 1,
        "unit_type": "unit",
        "url": "api/units/2"
      },
      "assignee": {
        "content_type": "user",
        "id": 3,
        "name": "Caleigh Breitenberg",
        "first_name": "Caleigh",
        "last_name": "Breitenberg",
        "title": "Postal Service Clerk",
        "avatar": null,
        "active": true,
        "unit": {
          "content_type": "unit",
          "id": 1,
          "name": "HQ",
          "level": 0,
          "unit_type": "unit",
          "url": "api/units/1"
        },
        "url": "api/users/3"
      },
      "applicants": [],
      "permissions": {
        "edit": false,
        "delete": false,
        "take": false,
        "request": false,
        "close": false,
        "apply": false,
        "approve": false
      }
    }
  ]
}

This endpoint retrieves a list of registrations. By default, both shifts and registrations will be returned. If you only want one type, please specify using the type query parameter.

HTTP Request

GET https://example.ziik.io/api/registrations

Query Parameters

Parameter	Type	Default	Description
assignee_id	Integer	N/A	Filter to a specific user id. Required if no units provided
units	Array of integers	N/A	Filter to specific unit ids. Required if no assignee_id provided
start	Integer	NULL	Unix timestamp of earliest start time of a registration
end	Integer	NULL	Unix timestamp of latest start time of a registration
type	String	All	Supported values: "shift" and "vacation"
relations	Array of strings	None	List of relations to load with the registration. Supported values: "unit" and "assignee"

Get Registration

curl "https://example.ziik.io/api/registrations/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"

The above command returns JSON structured like this:

{
  "data": {
    "id": 1,
    "type": "shift",
    "start": 1540857600,
    "end": 1540861200,
    "note": null,
    "comment": null,
    "break": null,
    "open_for_trade": false,
    "corrected_working_hours_start": null,
    "corrected_working_hours_end": null,
    "corrected_working_hours_note": null,
    "unit_id": 2,
    "assignee_id": 3,
    "unit": {
      "content_type": "unit",
      "id": 2,
      "name": "Wyman, Beer and Hane",
      "level": 1,
      "unit_type": "unit",
      "url": "api/units/2"
    },
    "assignee": {
      "content_type": "user",
      "id": 3,
      "name": "Caleigh Breitenberg",
      "first_name": "Caleigh",
      "last_name": "Breitenberg",
      "title": "Postal Service Clerk",
      "avatar": null,
      "active": true,
      "unit": {
        "content_type": "unit",
        "id": 1,
        "name": "HQ",
        "level": 0,
        "unit_type": "unit",
        "url": "api/units/1"
      },
      "url": "api/users/3"
    },
    "applicants": [],
    "permissions": {
      "edit": false,
      "delete": false,
      "take": false,
      "request": false,
      "close": false,
      "apply": false,
      "approve": false
    }
  }
}

This endpoint returns a registration.

HTTP Request

GET https://example.ziik.io/api/registrations/ID

URL Parameters

Parameter	Type	Description
ID	Integer	The ID of the registration

Permissions Required

• Authenticated user

Edit Shift

curl -i -X PATCH "https://example.ziik.io/api/shifts/123"
  -H "Authorization: Bearer aaaaaaaaa.bbbbbbbbb.cccccccccc"
  -d "{ [...] }"

The above command returns 204 No Content on successful update.

HTTP/1.0 204 No Content

This endpoint updates an existing shift.

HTTP Request

PATCH https://example.ziik.io/api/shifts/ID

Request Parameters

Parameter	Type	Required	Description
unit	Integer	No	Unit to create shift in. Defaults to user's own unit
start	Integer	No	Unix timestamp of when the shift begins
end	Integer	No	Unix timestamp of when the shift ends
assigned	Integer	No	User ID of shift assignee
trade	Boolean	No	Whether the shift should be available for trade

Permissions Required

• Schedule permission to units and shift's unit equal to user's unit or below

Delete Shift

curl -i -X DELETE "https://example.ziik.io/api/shifts/123"
  -H "Authorization: Bearer aaaaaa.bbbbbbb.ccccccc"

The above command returns a 204 No Content header on success:

HTTP/1.0 204 No Content

This endpoint deletes a shift.

HTTP Request

DELETE https://example.ziik.io/api/shifts/ID

URL Parameters

Parameter	Type	Description
ID	Integer	The ID of the shift to delete

Permissions Required

• Schedule permission to units and shift's unit equal to user's unit or below