GET
/api/v1/assignment-files/:idDownload
assignment:viewMODULE GUIDE · 11 OCT 2026
Homework & assignments
Create and distribute class work, collect student submissions and record grading feedback.
OVERVIEW
What you can do
01
Class and section scope
02
Assignment attachments
03
Submission queue
04
Grading
05
History
06
In-app reminders
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
assignment:viewassignment:updateassignment:createassignment: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 teaching section and create an assignment
An assigned school account with the required permissions.
- 02
Add the instructions, due date and supported files
Assignment attachments is part of the documented workflow.
- 03
Review submitted or pending work
Submission queue is part of the documented workflow.
- 04
Grade the submission and review the activity history
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 |
|---|---|---|
assignmentId | string | Optional |
dueInDays | number | Optional |
title | string | Required by declaration |
classId | string | Optional |
sectionId | string | Optional |
subjectId | string | Optional |
instructions | string | Optional |
maxMarks | number | Optional |
dueDate | string | Optional |
status | 'DRAFT' | 'PUBLISHED' | 'CLOSED' | Optional |
version | string | Optional |
correctionReason | string | Optional |
outcome | 'GRADED' | 'RETURNED' | Optional |
marksObtained | number | Optional |
remarks | string | Optional |
CURRENT BEHAVIOUR
Rules & current limits
- Attachment access and learner submissions follow school and child ownership. Reminder delivery depends on the configured channel.
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 homework & assignments
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
13 source-declared operations
POST
/api/v1/assignments/:id/filesUpload
assignment:updateGET
/api/v1/assignmentsList
assignment:viewGET
/api/v1/assignments/dashboardDashboard
assignment:viewGET
/api/v1/assignments/pendingPending
assignment:viewPOST
/api/v1/assignments/remindRemind
assignment:updateDeclared request fields: assignmentId (optional), dueInDays (optional).
GET
/api/v1/assignments/:id/remindersReminder History
assignment:viewGET
/api/v1/assignments/:id/historyHistory
assignment:viewGET
/api/v1/assignments/:idGet
assignment:viewPOST
/api/v1/assignmentsCreate
assignment:createDeclared request fields: title (required), classId (optional), sectionId (optional), subjectId (optional), instructions (optional), maxMarks (optional), dueDate (optional), status (optional), version (optional).
PATCH
/api/v1/assignments/:idUpdate
assignment:updateDELETE
/api/v1/assignments/:idRemove
assignment:deletePATCH
/api/v1/assignments/submissions/:submissionId/gradeGrade Submission
assignment:updateDeclared request fields: version (optional), correctionReason (optional), outcome (optional), marksObtained (optional), remarks (optional).
Open the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.