Sign in
operator-handovers

Move the handover's header dates

Changed on

The admin moves any of due_at, starts_at, ends_at; the operator only their own leave dates — starts_at while it is still ahead, ends_at later only. Every change is recorded in events.

patch/api/operator-handovers/{handover_id}

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/operator-handovers/{handover_id}
  • Auth: HTTP bearer

Path parameters

handover_idstring uuid required

Request body

due_atstring date-time nullable

Admin only

starts_atstring date-time nullable

Temporary only; the operator only while it is still ahead

ends_atstring date-time nullable

Temporary only; the operator may only push it later

Response

Successful Response

idstring uuid required
operator_idstring uuid required
operator_namestring nullable
expert_type'PSICOLOGO' | 'NUTRIZIONISTA' required

Operator profession constants.

reason'resignation' | 'termination' | 'temporary_replacement' required

Why a departing operator's handover was activated.

replacement_kind'maternity' | 'other'

Sub-kind of a temporary replacement — a label and a filter, no behaviour.

reason_notestring nullable
due_atstring date-time required
last_operator_event_atstring date-time nullable

When the operator last moved a leave date — the admin's unread mark

kind'departure' | 'return' required

A departure, or the return handover that follows a temporary one.

parent_handover_idstring uuid nullable

The departure this return follows; set iff kind is return

supervision_meeting_idstring uuid nullable
supervision_datestring date-time nullable

The linked meeting's date, which gates compilation; null until one is linked

supervision_labelstring nullable
starts_atstring date-time nullable
ends_atstring date-time nullable
activated_atstring date-time required
closed_atstring date-time nullable
patients_totalinteger required

Roster size — the progress bar's denominator: live patients plus anyone already decided on

patients_decidedinteger required

Roster lines carrying a decision — the progress bar's numerator

progress'to_fill' | 'in_progress' | 'completed' required

A whole handover's progress, rolled up over its rows — never stored.

activated_by_user_idstring uuid required
closed_by_user_idstring uuid nullable
absence_warningstring nullable

Activation only: set when a temporary replacement's leave could not be recorded as an absence because of conflicting appointments or openings

Changes