Student Answer Sheet

GET - Student Answer Sheet List

The 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:

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.
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.

GET

evaluation-platform

exam

{examId}

answer-sheet

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/ \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "cec7fcaa-9cef-4d5b-8aff-297a022f6666",
      "documents": [],
      "studentId": "",
      "instituteId": "",
      "teacherId": "",
      "studentName": "",
      "parentId": ""
    },
    {
      "id": "946c75fe-12a6-4868-bf59-9ee12527263f",
      "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

Response

200

application/json

Successfully Retrieved Data

data

object[]

Array of student answers sheets along with documents

data.id

string

Unique identifier of the student answer sheet

Example:

"cec7fcaa-9cef-4d5b-8aff-297a022f6666"

data.documents

object[]

List of documents associated with the student answer sheet

Example:

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

data.studentId

string

Unique identifier of the student

Example:

"2017009807"

data.instituteId

string

Unique identifier of the institute

Example:

"98765"

data.teacherId

string

Unique identifier of the teacher

Example:

"54321"

data.studentName

string

Name of the student

Example:

"John Doe"

data.parentId

string

Unique identifier of the parent

Example:

"11223"

PATCH - Student Answer Sheet GET - Pre-Provisional Scores

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/ \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "cec7fcaa-9cef-4d5b-8aff-297a022f6666",
      "documents": [],
      "studentId": "",
      "instituteId": "",
      "teacherId": "",
      "studentName": "",
      "parentId": ""
    },
    {
      "id": "946c75fe-12a6-4868-bf59-9ee12527263f",
      "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

GET - Student Answer Sheet List

Authorizations

Path Parameters

Response