GET - Assignment
This API allows authenticated users to retrieve the details of a specific assignment by providing its unique ID.
Key Notes:
id
(required in path): The unique identifier of the assignment to be retrieved.- Returns all metadata related to the assignment including its name, institute details, grade, section, and document status.
Scenario: Viewing a Previously Created Assignment
- A teacher wants to verify the information of an already created assignment.
- They send a GET request with the assignment’s ID.
- The system returns all associated details, including whether documents were uploaded and if extraction has begun.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier of the assignment
Response
Unique identifier for the assignment.
"2600413f-7c6e-46ef-8ea9-3e7b5834879f"
Name of the assignment.
"English Assignment"
Status of the assignment (refer this doc to get the constants)
2
Grade of the assignment.
"7"
10
Section of the assignment.
"A"
ID of the parent institute.
"100"
ID of the institute.
"200"
ID of the course.
"300"
List of documents associated with the assignment.
Created date for the assignment.
"2025-04-06T09:03:42.099207Z"
Modified date of the assignment.
"2025-04-06T09:06:19.351379Z"