Assignment

LIST - Assignment

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, and previous to handle pagination.
The data field contains an array of assignment objects following the UpdatedAssignmentResponse 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

assignment-evaluation

assignment

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 20,
  "pageSize": 10,
  "showing": "Page 1 of 2",
  "next": "{{base_url}}/assignment-evaluation/v1/assignment/?page=2",
  "previous": null,
  "data": [
    {
      "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
      "assignmentName": "English Assignment",
      "status": 2,
      "grade": "7",
      "marks": 10,
      "section": "A",
      "parentInstituteId": "100",
      "instituteId": "200",
      "courseId": "300",
      "documents": [
        {
          "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
          "status": 1,
          "pageNo": 1,
          "uploadTime": "2025-04-06T09:04:11.716434Z",
          "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
          "fileType": 1
        }
      ],
      "createdAt": "2025-04-06T09:03:42.099207Z",
      "modifiedAt": "2025-04-06T09:06:19.351379Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

List of assignments retrieved successfully.

count

integer

Total number of assignments available.

Example:

20

pageSize

integer

Number of items displayed per page.

Example:

10

showing

string

Current page display information.

Example:

"Page 1 of 2"

string | null

URL for the next page of results.

Example:

"{{base_url}}/assignment-evaluation/v1/assignment/?page=2"

string | null

URL for the previous page of results.

Example:

null

data

object[]

GET - Assignment GET - Extracted Assignment Question

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 20,
  "pageSize": 10,
  "showing": "Page 1 of 2",
  "next": "{{base_url}}/assignment-evaluation/v1/assignment/?page=2",
  "previous": null,
  "data": [
    {
      "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
      "assignmentName": "English Assignment",
      "status": 2,
      "grade": "7",
      "marks": 10,
      "section": "A",
      "parentInstituteId": "100",
      "instituteId": "200",
      "courseId": "300",
      "documents": [
        {
          "id": "bec0d0bf-fff6-40de-9750-65f5dcaf470d",
          "status": 1,
          "pageNo": 1,
          "uploadTime": "2025-04-06T09:04:11.716434Z",
          "url": "https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf",
          "fileType": 1
        }
      ],
      "createdAt": "2025-04-06T09:03:42.099207Z",
      "modifiedAt": "2025-04-06T09:06:19.351379Z"
    }
  ]
}

Authentication

K12

Assessment Rubrics

Standardized Language Exams

LIST - Assignment

Authorizations

Response