Student Answer Sheet

PATCH - Student Answer Sheet

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

Scenarios:

Uploading PDF Document to a Student’s Answer Sheet:
- The teacher provides the Answer Sheet ID and uploads a PDF.
- Outcome:
  - The student’s scanned answer sheet is successfully uploaded in PDF format, replacing the placeholder document.
Uploading Multiple JPEG Images for a Student’s Answer Sheet:
- A student’s handwritten answer sheet is scanned in parts and saved as multiple JPEG images.
- The teacher uploads each image sequentially using the same Answer Sheet ID.
- Outcome:
  - All images are uploaded, completing the student’s answer 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.

PATCH

evaluation-platform

exam

{examId}

answer-sheet

{id}

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form isFinal=true

{
  "id": "f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223",
  "documents": [
    {
      "id": "10d5661d-df3a-4d22-aa58-fddfa1230040",
      "status": 1,
      "pageNo": null,
      "uploadTime": "2025-01-06T12:28:22.992639Z",
      "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/2017009807.pdf",
      "fileType": 1
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

examId

string

required

Example:

"4340132f-50fa-4877-9ffa-e9b7ee59d51f"

string

required

Example:

"f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab"

Body

multipart/form-data

The details to update for the model answer.

documents

file

The model answer file to be uploaded.

isFinal

boolean

After successfully uploaded files pass this parameter as true for the extraction for your exam.

Example:

true

Response

200

application/json

Successful response

string

Unique identifier of the student answer sheet

Example:

"f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab"

studentId

string

Unique identifier of the student

Example:

"2017009807"

instituteId

string

Unique identifier of the institute

Example:

"98765"

teacherId

string

Unique identifier of the teacher

Example:

"54321"

studentName

string

Name of the student

Example:

"John Doe"

parentId

string

Unique identifier of the parent

Example:

"11223"

documents

object[]

List of documents associated with the student answer sheet

POST - Student Answer Sheet GET - Student Answer Sheet List

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form isFinal=true

{
  "id": "f5f2576f-1e3a-4869-88ae-a2c6cd2b9eab",
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223",
  "documents": [
    {
      "id": "10d5661d-df3a-4d22-aa58-fddfa1230040",
      "status": 1,
      "pageNo": null,
      "uploadTime": "2025-01-06T12:28:22.992639Z",
      "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/2017009807.pdf",
      "fileType": 1
    }
  ]
}

Authentication

K12

Assessment Rubrics

Standardized Language Exams

PATCH - Student Answer Sheet

Authorizations

Path Parameters

Body

Response