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

Get Assignment List

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

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<uri> | null

URL for the next page of results.

Example:

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

string<uri> | null

URL for the previous page of results.

Example:

null

data

object[]

Show child attributes

data.id

string<uuid>

Unique identifier for the assignment.

Example:

"2600413f-7c6e-46ef-8ea9-3e7b5834879f"

data.assignmentName

string

Name of the assignment.

Example:

"English Assignment"

data.status

integer

Status of the assignment (refer this doc to get the constants)

Example:

2

data.grade

string

Grade of the assignment.

Example:

"7"

data.marks

integer | null

Example:

10

data.section

string

Section of the assignment.

Example:

"A"

data.parentInstituteId

string

ID of the parent institute.

Example:

"100"

data.instituteId

string

ID of the institute.

Example:

"200"

data.courseId

string

ID of the course.

Example:

"300"

data.documents

object[]

List of documents associated with the assignment.

Show child attributes

data.documents.id

string<uuid>

Unique identifier for the document.

Example:

"bec0d0bf-fff6-40de-9750-65f5dcaf470d"

data.documents.status

integer

Status of the document.

Example:

1

data.documents.pageNo

integer | null

Example:

1

data.documents.uploadTime

string<date-time>

Upload time of the document.

Example:

"2025-04-06T09:04:11.716434Z"

data.documents.url

string<uri>

URL of the document.

Example:

"https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf"

data.documents.fileType

integer

Type of the file.

Example:

1

data.createdAt

string<date-time>

Created date for the assignment.

Example:

"2025-04-06T09:03:42.099207Z"

data.modifiedAt

string<date-time>

Modified date of the assignment.

Example:

"2025-04-06T09:06:19.351379Z"

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`, 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. <Tip> Want to receive automatic notifications when assignment questions are processed? Set up webhooks to get real-time updates on assignment questions extraction. Check out the [Webhooks](/api-reference/endpoint/webhook/v1-get-webhook-template). </Tip>

⌘I

Get Assignment List

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

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

LIST - Assignment

Authorizations

Response