DOBS API Documentation

None

{
  "name": "Jane Smith",
  "pin": "1234"
}

200 Sets session cookie and returns staff profile.

{
  "staff": { "id": 1, "name": "Jane Smith", "role": "admin" }
}

401 Invalid credentials.

None

None

200 Clears auth cookie.

{ "ok": true }

Session Cookie / Bearer Token 200 Returns current staff profile with refreshed token.

{
  "staff": { "id": 1, "name": "Jane Smith", "role": "admin" }
}

401 No valid session.

None (first-run only)

Creates the default admin account if no staff members exist. Used during initial setup.

200 Admin created or already exists.

{ "ok": true, "seeded": true }

Session Cookie / Bearer Token

{
  "currentPin": "1234",
  "newPin": "5678"
}

200 PIN updated successfully.

{ "ok": true }

401 Current PIN incorrect.

Session Cookie / Bearer Token 200 Array of staff members.

{
  "staff": [
    { "id": 1, "name": "Jane Smith", "role": "admin" }
  ]
}

Admin

{
  "name": "New Staff",
  "pin": "1234",
  "role": "staff"
}

201 Created staff member.

{ "staff": { "id": 2, "name": "New Staff", "role": "staff" } }

Admin

id (required) — Staff member ID

{
  "name": "Updated Name",
  "role": "admin"
}

200 Updated staff member.

Admin

id (required) — Staff member ID

200 Staff member removed.

{ "ok": true }

Session Cookie / Bearer Token 200 Array of active residents.

{
  "residents": [
    { "id": 1, "firstName": "John", "lastName": "Doe", "roomNumber": "12" }
  ]
}

Admin

{
  "firstName": "John",
  "lastName": "Doe",
  "roomNumber": "12",
  "dateOfBirth": "1940-05-12"
}

201 Created resident.

Session Cookie / Bearer Token

id (required) — Resident ID

{
  "firstName": "John",
  "roomNumber": "14"
}

200 Updated resident record.

Session Cookie / Bearer Token

periodId (required) — Period ID to fetch entries for

200 Array of body map entries.

{
  "entries": [
    {
      "id": 1, "bodyView": "front",
      "injuryType": "bruise", "description": "...",
      "x": 120, "y": 340
    }
  ]
}

Session Cookie / Bearer Token

{
  "periodId": 1,
  "residentId": 1,
  "bodyView": "front",
  "x": 120,
  "y": 340,
  "injuryType": "bruise",
  "description": "Small bruise on left forearm",
  "actionTaken": "Monitored",
  "remediation": "",
  "followUpDate": "2026-04-15",
  "observationType": "injury",
  "imageUrl": "",
  "woundLength": 2.5,
  "woundWidth": 1.0,
  "woundDepth": 0
}

201 Created entry with optional safeguarding alert.

{
  "entry": { ... },
  "alert": null
}

Session Cookie / Bearer Token

{
  "id": 1,
  "description": "Updated description",
  "actionTaken": "Applied dressing"
}

200 Updated entry object.

Session Cookie / Bearer Token

{
  "residentId": 1,
  "location": "Lounge",
  "activity": "Watching TV",
  "mood": 3,
  "asleep": false,
  "riskFlags": ["fall_risk"],
  "notes": "",
  "isIncident": false
}

201 Created observation with optional escalation.

{
  "check": { ... },
  "escalation": null
}

Session Cookie / Bearer Token

residentId (required) — Resident ID
from (optional) — Start date ISO string
to (optional) — End date ISO string

200 Array of observation checks.

{ "checks": [ ... ] }

Session Cookie / Bearer Token

residentId (required) — Resident ID
days (optional, default 7) — Number of days

200 Mood, sleep, incident, and location trends with compliance score.

{
  "moodData": [ ... ],
  "sleepData": [ ... ],
  "incidentData": [ ... ],
  "locationData": [ ... ],
  "compliance": 85,
  "summary": { "avgMood24h": 3.2, "totalChecks": 48 }
}

Session Cookie / Bearer Token

{
  "residentId": 1,
  "systolic": 120,
  "diastolic": 80,
  "pulse": 72,
  "temperature": 36.8,
  "respRate": 16,
  "o2Saturation": 97,
  "consciousness": "A",
  "supplementalO2": false,
  "notes": ""
}

201 Created vitals record with NEWS2 score and optional escalation.

{
  "vitals": { ..., "news2Score": 2, "news2RiskLevel": "low" },
  "escalation": null
}

Session Cookie / Bearer Token

{
  "residentId": 1,
  "entryType": "fluid",
  "description": "Cup of tea",
  "amountMl": 200,
  "calories": 30,
  "mealPeriod": "morning",
  "refused": false,
  "assistance": "independent",
  "notes": ""
}

201 Created food/fluid entry with optional escalation.

{
  "entry": { ... },
  "escalation": null
}

Session Cookie / Bearer Token

{
  "residentId": 1,
  "eyeOpening": 4,
  "verbalResponse": 5,
  "motorResponse": 6,
  "pupilLeft": "reactive",
  "pupilRight": "reactive",
  "limbMovement": "normal",
  "notes": ""
}

201 Created neurological observation with GCS score.

{
  "neuro": { ..., "gcsTotal": 15 },
  "escalation": null
}

Session Cookie / Bearer Token

residentId (required) — Resident ID

200 Array of documentation periods.

{
  "periods": [
    { "id": 1, "residentId": 1, "label": "April 2026" }
  ]
}

Session Cookie / Bearer Token

{
  "residentId": 1,
  "label": "April 2026"
}

201 Created period.

Admin

format (optional) — "csv" for CSV, omit for PDF
type (optional, CSV only) — "entries" | "obs_checks" | "vitals"
residentId (optional) — Filter to single resident
from (optional) — Start date (ISO)
to (optional) — End date (ISO)
includePhotos (optional, PDF only) — "true" to include photos

PDF: Content-Type: application/pdf — Streams the report as a file download.

CSV: Content-Type: text/csv — Returns CSV with columns specific to the type.

entries: Date, Time, Staff, Resident, Room, Type, Category,
  Body View, Description, Action Taken, Remediation,
  Follow-up Date, Wound L/W/D (cm), Photo URL

obs_checks: Date, Time, Staff, Resident, Room, Location,
  Activity, Mood, Asleep, Incident, Risk Flags, Notes

vitals: Date, Time, Staff, Resident, Systolic, Diastolic,
  Pulse, Temp, Resp Rate, O2 Sat, Consciousness, NEWS2 Score

Session Cookie / Bearer Token 200 Array of safeguarding alerts.

{
  "alerts": [
    {
      "id": 1,
      "residentId": 1,
      "type": "repeat_location",
      "severity": "high",
      "status": "pending"
    }
  ]
}

Session Cookie / Bearer Token

{
  "id": 1,
  "status": "reviewed",
  "notes": "Investigated - no concern"
}

200 Updated alert.