GET
/api/v1/timetable/day-planA day's timetable with substitutions applied
timetable:viewSCREEN GUIDE · 11 OCT 2026
Teacher cover
Use teacher cover in the school workspace. Build recurring class schedules and arrange dated teacher cover with clash checks.
OVERVIEW
What you can do
01
Assign
02
Withdraw
03
A day's timetable with substitutions applied
04
List Substitutions
05
Who could cover an absent teacher (suggestions only)
06
Record cover for all of an absent teacher's periods on a date
07
Assign one substitute to one period on one date
08
Remove Substitution
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
Required permission keys
timetable:viewtimetable:createtimetable:deleteUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Select the section, teacher and date
A school account with the permissions shown below.
- 02
Create a period with its subject, time and room
Withdraw is part of the documented workflow.
- 03
Resolve overlap warnings before saving
A day's timetable with substitutions applied is part of the documented workflow.
- 04
Arrange dated cover and review the daily plan
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
absentStaffId | string | Required by declaration |
date | string | Required by declaration |
apply | boolean | Optional |
reason | string | Optional |
autoGenerated | boolean | Optional |
periodId | string | Required by declaration |
substituteStaffId | string | Required by declaration |
CURRENT BEHAVIOUR
Rules & current limits
- Workspace checks include section, teacher and room overlaps. Weekly templates retain the recurring teacher; dated cover appears in the daily view.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try teacher cover
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
6 source-declared operations
GET
/api/v1/timetable/substitutionsList Substitutions
timetable:viewPOST
/api/v1/timetable/substitutions/suggestWho could cover an absent teacher (suggestions only)
timetable:viewDeclared request fields: absentStaffId (required), date (optional), apply (optional), reason (optional), autoGenerated (optional).
POST
/api/v1/timetable/substitutions/generateRecord cover for all of an absent teacher's periods on a date
timetable:createDeclared request fields: absentStaffId (required), date (optional), apply (optional), reason (optional), autoGenerated (optional).
POST
/api/v1/timetable/substitutionsAssign one substitute to one period on one date
timetable:createDeclared request fields: periodId (required), date (required), substituteStaffId (required), reason (optional).
DELETE
/api/v1/timetable/substitutions/:idRemove Substitution
timetable:deleteOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.