MODULE GUIDE · 11 OCT 2026

Timetable & teacher cover

Build recurring class schedules and arrange dated teacher cover with clash checks.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

Weekly and daily views

Class and teacher filters

Periods and rooms

Time-overlap checks

Dated cover

Availability review

History and print

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

An assigned school account with the required permissions.
The academic, student or staff setup used by this workflow.

Required permission keys

timetable:viewtimetable:createtimetable:deletetimetable:update

Use 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
An assigned school account with the required permissions.
02
Create a period with its subject, time and room
Class and teacher filters is part of the documented workflow.
03
Resolve overlap warnings before saving
Periods and rooms 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
`version`	string	Optional
`periodId`	string	Required by declaration
`date`	string	Required by declaration
`substituteStaffId`	string	Required by declaration
`reason`	string	Optional
`status`	'PLANNED' \| 'CONFIRMED' \| 'CANCELLED'	Required by declaration
`sectionId`	string	Required by declaration
`dayOfWeek`	number	Required by declaration
`periodNo`	number	Required by declaration
`startTime`	string	Required by declaration
`endTime`	string	Required by declaration
`subjectId`	string	Optional
`teacherStaffId`	string	Optional
`roomNo`	string	Optional
`periodType`	string	Optional
`force`	boolean	Optional
`absentStaffId`	string	Required by declaration
`apply`	boolean	Optional
`autoGenerated`	boolean	Optional

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

Try timetable & teacher cover

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →

FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

16 source-declared operations

GET/api/v1/timetable/workspace

Read

timetable:view

POST/api/v1/timetable/workspace/periods

Save

timetable:create

Declared request fields: version (optional).

POST/api/v1/timetable/workspace/periods/:id/delete

Remove

timetable:delete

Declared request fields: version (required).

POST/api/v1/timetable/workspace/covers

Cover

timetable:create

Declared request fields: periodId (required), date (required), substituteStaffId (optional), reason (required), status (required), version (optional).

GET/api/v1/timetable/my

The caller’s own week — periods they teach, or their section’s

Authenticated scope and endpoint-specific rules

GET/api/v1/timetable

Grid

timetable:view

POST/api/v1/timetable/periods

Upsert Period

timetable:create

Declared request fields: sectionId (required), dayOfWeek (required), periodNo (required), startTime (required), endTime (required), subjectId (optional), teacherStaffId (optional), substituteStaffId (optional), roomNo (optional), periodType (optional), force (optional).

DELETE/api/v1/timetable/periods/:id

Remove Period

timetable:delete

GET/api/v1/timetable/clashes

Audit saved timetables for teacher/room/overlap clashes

timetable:view

GET/api/v1/timetable/day-plan

A day's timetable with substitutions applied

timetable:view

GET/api/v1/timetable/substitutions

List Substitutions

timetable:view

POST/api/v1/timetable/substitutions/suggest

Who could cover an absent teacher (suggestions only)

timetable:view

Declared request fields: absentStaffId (required), date (optional), apply (optional), reason (optional), autoGenerated (optional).

POST/api/v1/timetable/substitutions/generate

Record cover for all of an absent teacher's periods on a date

timetable:create

Declared request fields: absentStaffId (required), date (optional), apply (optional), reason (optional), autoGenerated (optional).

POST/api/v1/timetable/substitutions

Assign one substitute to one period on one date

timetable:create

Declared request fields: periodId (required), date (required), substituteStaffId (required), reason (optional).

PATCH/api/v1/timetable/substitutions/:id/status

Set Substitution Status

timetable:update

Declared request fields: status (required).

DELETE/api/v1/timetable/substitutions/:id

Remove Substitution

timetable:delete

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/school/substitutionsOpen ↗/en/school/timetableOpen ↗

Timetable & teacher cover

What you can do

Weekly and daily views

Class and teacher filters

Periods and rooms

Time-overlap checks

Dated cover

Availability review

History and print

Access & setup

How the workflow works

Select the section, teacher and date

Create a period with its subject, time and room

Resolve overlap warnings before saving

Arrange dated cover and review the daily plan

Request fields to understand

Rules & current limits

Try timetable & teacher cover

API & permissions reference

Open the actual application

Keep exploring