Remove a roster shift
A draft goes at once (status: removed); a published shift is removed at the next publish (removing: true), and its
person is told then.
Scope: attendance:manage · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: attendance:manage
roster_shift_id*stringThe roster shift's ID.
^roster_shift_[0-7][0-9a-hjkmnp-tv-z]{25}$"roster_shift_01m5dk4qexa6kwfsr9nhy4r7w5"Idempotency-Key*stringA UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidThe roster shift.
application/json- response
A shift on a site's roster. A published shift with a change waiting shows its published values.
id*RosterShiftIdA roster shift ID (TypeID with the roster_shift prefix).
^roster_shift_[0-7][0-9a-hjkmnp-tv-z]{25}$"roster_shift_01m5dk4qexa6kwfsr9nhy4r7w5"site_id*SiteIdA site ID (TypeID with the site prefix).
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"person_id*|Who works it; null for an open shift.
open*booleanNo one works it yet: once published, staff who can take it may ask for it.
on_date*stringThe local day it belongs to at its site (a night shift belongs to the evening it starts).
datestarts_at*stringdate-timeends_at*stringdate-timestart_time*stringLocal time at the site, HH:MM.
"20:00"end_time*stringLocal time at the site, HH:MM.
"08:00"shift_id*ShiftIdA shift ID (TypeID with the shift prefix).
^shift_[0-7][0-9a-hjkmnp-tv-z]{25}$"shift_01kn6pqfm0fmasbh61jnr3syze"name*string"Night gate"label*|"Main gate"colour*string"blue""teal""green""gold""amber""rose""violet""slate"break_kind*|Its break; null follows your organisation's standard day.
"none""paid""unpaid"nullbreak_minutes*integer|nullbreak_starts*|When the planned break starts, HH:MM.
note*|Shown to the person with the shift.
status*stringdraft: staff don't see it yet. cancelled: removed after it was published. removed: a draft taken off.
"draft""published""cancelled""removed"pending_change*booleanA change waits for the next publish.
removing*booleanIt will be removed at the next publish.
source*string"pattern""manual""import""swap""claim"published_at*|date-timecreated_at*stringdate-timeupdated_at*stringdate-timecurl -X DELETE 'https://api.agoo.ardent.africa/v1/roster-shifts/roster_shift_01m5dk4qexa6kwfsr9nhy4r7w5' \ -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64'{ "id": "roster_shift_01m5dk4qexa6kwfsr9nhy4r7w5", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "person_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "open": true, "on_date": "2019-08-24", "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "start_time": "20:00", "end_time": "08:00", "shift_id": "shift_01kn6pqfm0fmasbh61jnr3syze", "name": "Night gate", "label": "Main gate", "colour": "blue", "break_kind": "none", "break_minutes": 0, "break_starts": "string", "note": "string", "status": "draft", "pending_change": true, "removing": true, "source": "pattern", "published_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Change a roster shift PATCH
Changes a draft at once, or a published shift as a change waiting for the next publish (`pending_change: true`; staff keep seeing the published shift until then). Move it to someone else (`person_id: null` makes it an open shift), to another day keeping its clock times, to another template (bringing its times), or give it its own times or note. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Publish a site's roster POST
Every draft and change waiting at the site reaches staff: drafts are published, changes applied, removals made. Each person whose shifts still to come changed is told once, and staff who can take a new open shift hear of it. Refused with `conflict` while two of someone's shifts would overlap at any site; a change to a published shift starting within 48 hours needs a `note` (`validation_failed`); nothing waiting is `invalid_state`. `roster.published` fires. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.