/api/v1/promotions/previewDry-run a rollover — writes nothing
promotion:viewDeclared request fields: fromSessionId (required), toSessionId (required), criteria (optional).
Preview new-session student placement and apply or revert a recorded promotion batch.
Intended access: Assigned account with the required permissions.
promotion:viewpromotion:createpromotion:managepromotion:deletestudent:viewUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
An assigned school account with the required permissions.
Structure clone is part of the documented workflow.
Promotion commit is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
fromSessionId | string | Required by declaration |
toSessionId | string | Required by declaration |
criteria | PromotionCriteriaDto | Optional |
includeTimetables | boolean | Optional |
decisions | StudentDecisionDto[] | Required by declaration |
activateTargetSession | boolean | Optional |
notes | string | Optional |
graduationYear | number | Optional |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
/api/v1/promotions/previewDry-run a rollover — writes nothing
promotion:viewDeclared request fields: fromSessionId (required), toSessionId (required), criteria (optional).
/api/v1/promotions/clone-structureCopy classes/sections/subjects into the new session
promotion:createDeclared request fields: fromSessionId (required), toSessionId (required), includeTimetables (optional).
/api/v1/promotions/commitApply the rollover (transactional)
promotion:manageDeclared request fields: fromSessionId (required), toSessionId (required), decisions (required), activateTargetSession (optional), notes (optional), graduationYear (optional).
/api/v1/promotions/batches/:id/revertRevert
promotion:delete/api/v1/promotions/batchesBatches
promotion:view/api/v1/promotions/enrollmentsPer-session placement history for a student
student:viewERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.