POST - Assignment
This API allows authenticated users to create a new assignment by providing essential details like assignment name, institute info, and class metadata.
Key Notes:
assignmentName(required): The title of the assignment.parentInstituteId,instituteId,courseId: Help link the assignment to the correct organizational hierarchy.gradeandsection: Specify the targeted academic group for the assignment.
Scenario: Creating an Assignment for Grade 8 - Section B
- A teacher wants to assign a new English essay task to Grade 8 students of Section B.
- They send a POST request with all necessary metadata.
- Upon success, the assignment is created and returns an ID, ready for document uploads and evaluation.
POST
Create Assignment
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Name of the assignment
Example:
"English Assignment"
ID of the parent institute
Example:
"101"
ID of the institute
Example:
"202"
ID of the course
Example:
"303"
Grade of the assignment
Example:
"8"
Section of the assignment
Example:
"B"
Previous
PATCH - Assignment This API allows authenticated users to update an existing assignment by modifying its details or uploading assignment documents.
**Key Notes:**
- `id` (required in path): Unique identifier of the assignment to be updated.
- Request body accepts `multipart/form-data` for file uploads.
- You can update metadata like `assignmentName`, `grade`, `section`, or upload a document file using the `documents` field.
- Use the `isFinal` flag to signal that the document upload is complete, which will trigger document extraction.
**Scenario: Uploading the Final Document**
- A teacher updates the assignment by uploading the final assignment PDF and setting `isFinal` to `true`.
- This flags the system to begin extracting content from the uploaded file.
<Danger> If both `documents` and `isFinal` are provided in the same request, a validation error is returned. Use either `documents` to upload, or `isFinal` to trigger extraction — **not both together**. </Danger>
Next
Create Assignment