PATCH - Student Assignment Sheet

The API allows clients to upload and associate documents with an existing student assignment sheet for a specific assignment. Only one type of file format (either PDF or multiple images like JPEG) is allowed for a single assignment sheet. Mixing formats in a single assignment sheet is not permitted.

Scenarios:

Uploading PDF Document to a Student’s assignment Sheet:
- The teacher provides the assignment Sheet ID and uploads a PDF.
- Outcome:
  - The student’s scanned assignment sheet is successfully uploaded in PDF format, replacing the placeholder document.
Uploading Multiple JPEG Images for a Student’s assignment Sheet:
- A student’s handwritten assignment sheet is scanned in parts and saved as multiple JPEG images.
- The teacher uploads each image sequentially using the same assignment Sheet ID.
- Outcome:
  - All images are uploaded, completing the student’s assignment sheet and associating them for grading.

Note:

After setting isFinal to true, the AI extraction process begins. This process may take some time to complete.
To streamline workflows, the system supports a webhook feature. Upon successful extraction, a notification is sent to the configured webhook URL.
Only one of documents or isFinal can be processed at a time.

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}

answer-sheet

{assignmentSheetId}

Update Assignment Answer Sheet

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'documents=<string>' \
  --form isFinal=true \
  --form documents.items='@example-file'

{
  "id": "57387c68-0706-4a9d-834a-237b6b63cb5d",
  "status": 0,
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "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
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Unique identifier of the assignment

assignmentSheetId

string

required

Unique identifier of the answer sheet

Body

multipart/form-data

documents

file[]

List of answer sheet documents to upload (if any).

isFinal

boolean

Flag to trigger evaluation if set to 'true'. Only one of documents, or isFinal is allowed.

Example:

true

Response

Answer sheet uploaded successfully.

string<uuid>

Unique identifier for the answer sheet.

Example:

"57387c68-0706-4a9d-834a-237b6b63cb5d"

status

integer

Status of the answer sheet (refer this doc to get the constants)

Example:

0

studentId

string

Unique identifier of the student.

Example:

"12345"

name

string

Name of the student.

Example:

"John Doe"

batchId

string | null

Unique identifier of the batch.

Example:

"batch_1"

sessionId

string | null

Unique identifier of the session.

Example:

"session_1"

documents

object[]

List of documents associated with the assignment.

Show child attributes

GET - Student Assignment SheetThe API retrieves all student assignment sheets associated with a particular assignment. It returns a list of answer sheets submitted or created for students under the specified assignment ID. This endpoint is typically used to display all submissions for a given assignment, allowing evaluators to access individual student sheets for grading or review. **Scenarios:** - Teacher views all student submissions for an assignment. - A teacher requests all answer sheets for a specific assignment. **Outcome:** - The API returns a list of assignment sheet records. - Each record includes metadata such as student ID, status (for example, In Progress or Failed), and answer sheet ID.

Update Assignment Answer Sheet

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/answer-sheet/{assignmentSheetId}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'documents=<string>' \
  --form isFinal=true \
  --form documents.items='@example-file'

{
  "id": "57387c68-0706-4a9d-834a-237b6b63cb5d",
  "status": 0,
  "studentId": "12345",
  "name": "John Doe",
  "batchId": "batch_1",
  "sessionId": "session_1",
  "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
    }
  ]
}

Documentation Index

Authorizations

Path Parameters

Body

Response