Assignment

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.

Important:

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.

PATCH

assignment-evaluation

assignment

{id}

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/ \
  --header 'Content-Type: multipart/form-data' \
  --form 'assignmentName=English Assignment' \
  --form parentInstituteId=100 \
  --form instituteId=200 \
  --form courseId=300 \
  --form grade=7 \
  --form section=A \
  --form isFinal=true

{
  "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"
}

Path Parameters

string

required

Unique identifier of the assignment

Body

multipart/form-data

assignmentName

string

Name of the assignment

Example:

"English Assignment"

parentInstituteId

string

ID of the parent institute

Example:

"100"

instituteId

string

ID of the institute

Example:

"200"

courseId

string

ID of the course

Example:

"300"

grade

string

Grade of the assignment

Example:

"7"

section

string

Section of the assignment

Example:

"A"

documents

file

The assignment file to be uploaded.

isFinal

boolean

After successfully uploaded the assignment then set isFinal as true it will start extracting your document.

Example:

true

Response

200

application/json

Assignment updated successfully

string

Unique identifier for the assignment.

Example:

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

assignmentName

string

Name of the assignment.

Example:

"English Assignment"

status

integer

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

Example:

2

grade

string

Grade of the assignment.

Example:

"7"

marks

integer | null

Example:

10

section

string

Section of the assignment.

Example:

"A"

parentInstituteId

string

ID of the parent institute.

Example:

"100"

instituteId

string

ID of the institute.

Example:

"200"

courseId

string

ID of the course.

Example:

"300"

documents

object[]

List of documents associated with the assignment.

createdAt

string

Created date for the assignment.

Example:

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

modifiedAt

string

Modified date of the assignment.

Example:

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

POST - Assignment GET - Assignment

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/ \
  --header 'Content-Type: multipart/form-data' \
  --form 'assignmentName=English Assignment' \
  --form parentInstituteId=100 \
  --form instituteId=200 \
  --form courseId=300 \
  --form grade=7 \
  --form section=A \
  --form isFinal=true

{
  "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

PATCH - Assignment

Path Parameters

Body

Response