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, multiple images like JPEG or public pdf link) is allowed for a single answer sheet. Mixing formats in a single answer sheet is not permitted.

Key Notes:

You can supply a PDF using fileUrl instead of uploading via documents.
fileUrl must be a public HTTPS URL, and the URL path must end with .pdf.
Use only one of documents, fileUrl, or isFinal in a single request (do not combine them).

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.

If both documents and isFinal are provided in the same request, a validation error is returned. Use the two-step flow: first submit documents (file/image/public PDF link), then send isFinal in a separate request. For link-based uploads, the PDF URL must be publicly accessible.

PATCH

evaluation-platform

exam

{examId}

answer-sheet

{id}

Update student answer sheet for an exam

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 documents='@example-file' \
  --form fileUrl=https://cdn.example.com/answer-sheet/answer-sheet-101.pdf \
  --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
    }
  ]
}

Video link - https://youtu.be/3Xh1BQpzlcs?si=4EKU4MeoY60VfW7I

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

The details to update for the student answer sheet.

documents

file

The student answer file to be uploaded.

fileUrl

string<uri>

Public HTTPS URL to a PDF. Use instead of uploading documents. The URL must be publicly accessible without authentication and must end with a .pdf extension.

Example:

"https://cdn.example.com/answer-sheet/answer-sheet-101.pdf"

isFinal

boolean

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

Example:

true

Response

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

Show child attributes

GET - Student Answer Sheet ListThe API retrieves details about all the student answer sheet for a specific exam, including its metadata and associated documents. These documents can either be: - A single PDF file, or - Multiple images (JPEG), each with a specific sequence. **Scenarios:** 1. **Reviewing All Student Answer Sheets for an Exam:** - A teacher or administrator needs to access and review all student answer sheets for a given exam. - **API Fetches:** - Metadata such as student IDs, and timestamps. - Associated documents (PDF or JPEG images). - **Outcome:** - The teacher can easily access and evaluate the answer sheets for all students, ensuring they are ready for grading or review. 2. **Validating the Submission Status of Student Answer Sheets:** - A content moderator or administrator needs to validate whether all answer sheets for a given exam have been submitted. - **API Returns:** - Metadata for each student’s answer sheet, including submission status and file type (PDF or JPEG). - **Outcome:** - The administrator confirms the submission status and checks the completeness and consistency of the submitted documents.

Update student answer sheet for an exam

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 documents='@example-file' \
  --form fileUrl=https://cdn.example.com/answer-sheet/answer-sheet-101.pdf \
  --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
    }
  ]
}

Documentation Index

Authorizations

Path Parameters

Body

Response