Assignment
GET - Extracted Assignment Question
This API allows authenticated users to retrieve a paginated list of assignments along with associated metadata like total count, pagination links, and assignment details.
Key Notes:
- The response includes
count
,pageSize
,showing
,next
, andprevious
to handle pagination. - The
data
field contains an array of assignment objects following theUpdatedAssignmentResponse
schema. - Useful for dashboards or any view where a user needs to browse or manage multiple assignments.
Scenario: Fetching Assignments for Review
- A teacher wants to review all assignments created for Grade 7.
- They send a GET request to this endpoint (optionally with query parameters for filtering/pagination).
- The system responds with a paginated list of assignments and relevant navigation links.
GET
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique identifier of the assignment
Response
200
application/json
Assignment retrieved successfully.
Unique identifier for the assignment
Example:
"2600413f-7c6e-46ef-8ea9-3e7b5834879f"
Name of the assignment
Example:
"English Assignment"
Instructions for the assignment
Example:
"Write a short story about a day in the life of a cat."
Total marks for the assignment
Example:
0
Grade of the assignment
Example:
"7"
ID of the course
Example:
"300"
List of parent questions in the assignment