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

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

Successfully Retrieved Data

data

object[]

Array of student answers sheets along with documents

Show child attributes

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

Show child attributes

data.documents.id

string

Unique identifier of the document

Example:

"10d5661d-df3a-4d22-aa58-fddfa1230040"

data.documents.status

integer

Status of the document

Example:

1

data.documents.pageNo

integer

Page number of the document

Example:

1

data.documents.uploadTime

string

Time of document upload

Example:

"2025-01-06T12:28:22.992639Z"

data.documents.url

string

URL of the document

Example:

"https://cgfblob.blob.core.windows.net/ielts/evaluation/2017009807.pdf"

data.documents.fileType

integer

Type of the document

Example:

1

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"

GET - Pre-Provisional ScoresThis API allows teachers to review detailed pre-provisional scores for an answer sheet associated with a specific exam. It includes section-wise and question-level details, evaluator feedback, and mechanisms for teachers to approve or adjust scores before they are released as provisional scores. The **GET Pre-Provisional Scores API** retrieves preliminary scores for a student’s exam, including: - Exam-level metadata such as total and obtained marks. - Section-level details with allocated and achieved marks. - Question-level insights, including model answers, student answers, feedback, and step-wise marking. **Scenarios:** 1. **AI Reviewing and Scoring the Student’s Answer Sheet:** - After submission, the AI reviews the answer sheet, processes the answers, and assigns preliminary scores according to section and question-specific marks. - **API Provides:** - **Exam-Level Metadata:** Total marks, obtained marks, and overall feedback. - **Section-Level Scores:** Marks allocated and achieved for each section. - **Question-Level Details:** AI’s scoring based on model answers, step-wise marking, and feedback. - **Outcome:** - AI generates pre-provisional scores, offering insights into how the model answer aligns with the student’s response. - The teacher can review and adjust scores before finalizing them. 2. **Reviewing AI’s Marking and Feedback Before Provisional Score Release:** - The teacher reviews the AI-generated pre-provisional scores. - The API displays AI feedback and scores calculated according to step-wise marking. - **Outcome:** - The teacher assesses AI feedback on each question and adjusts any scores before finalizing and releasing the provisional score. <Tip> Want to receive automatic notifications when student answer sheets are processed? Set up webhooks to get real-time updates on student answer extraction. Check out the [Webhooks](/api-reference/endpoint/webhook/v1-get-webhook-template). </Tip>

⌘I

cURL

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

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Student Answer Sheet List

Authorizations

Path Parameters

Response