POST - Student Answer Sheet

The API allows clients to create a new answer sheet for a specific student in an exam. It associates the student’s ID with an answer sheet and returns the unique ID for the answer sheet. The answer sheet can later be updated with documents (e.g., scanned PDFs or images).

Scenarios:

Creating a New Answer Sheet for a Student:
- A teacher provides the student’s ID to create a new answer sheet.
- Outcome:
  - The API generates a unique answer sheet ID linked to the student.
  - This ID is used for future reference and document uploads.
Associating Documents with the Created Answer Sheet:
- After scanning the student’s handwritten answer sheet, the teacher uploads a PDF or JPEG images using the unique answer sheet ID.
- Outcome:
  - The scanned document is associated with the student’s answer sheet, enabling it to be evaluated or graded in subsequent steps.

POST

evaluation-platform

exam

{examId}

answer-sheet

Create a new answer sheet for an exam

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}'

{
  "id": "3bbf06fe-f348-48cf-8995-dd71fc33589a",
  "documents": [],
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

examId

string

required

Body

application/json

studentId

string | null

Example:

"2017009807"

instituteId

string | null

Example:

"98765"

teacherId

string | null

Example:

"54321"

studentName

string | null

Example:

"John Doe"

parentId

string | null

Example:

"11223"

Response

Successfully Created

string

Unique identifier of the student answer sheet

Example:

"3bbf06fe-f348-48cf-8995-dd71fc33589a"

documents

object[]

List of documents associated with the student answer sheet initially empty

Show child attributes

Example:

[]

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"

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:** 1. **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. 2. **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.

Create a new answer sheet for an exam

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}'

{
  "id": "3bbf06fe-f348-48cf-8995-dd71fc33589a",
  "documents": [],
  "studentId": "2017009807",
  "instituteId": "98765",
  "teacherId": "54321",
  "studentName": "John Doe",
  "parentId": "11223"
}

Authentication

K12

Assessment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Standardized Language Exams

POST - Student Answer Sheet

Authorizations

Path Parameters

Body

Response