Create an exam answer sheet

POST

evaluation-platform

exam

{examId}

answer-sheet

Create an exam answer sheet

curl --request POST \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentId": "S-2043",
  "instituteId": "SCH-17",
  "teacherId": "T-1042",
  "studentName": "Aarav Sharma",
  "parentId": "P-9981"
}
'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/"

payload = {
    "studentId": "S-2043",
    "instituteId": "SCH-17",
    "teacherId": "T-1042",
    "studentName": "Aarav Sharma",
    "parentId": "P-9981"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    studentId: 'S-2043',
    instituteId: 'SCH-17',
    teacherId: 'T-1042',
    studentName: 'Aarav Sharma',
    parentId: 'P-9981'
  })
};

fetch('https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b",
  "documents": [],
  "studentId": "S-2043",
  "instituteId": "SCH-17",
  "teacherId": "T-1042",
  "studentName": "Aarav Sharma",
  "parentId": "P-9981"
}

Step 5 of 8 in Evaluate an exam. Create one sheet per student. Save the id you get back.

Rules

The exam’s questions and its answer key must both be extracted first. Otherwise you get 400 Exam is not processed yet or 400 Model Answer is not processed yet.
Every field is optional, and every field is your own reference. Send studentId, studentName, teacherId, instituteId, and parentId so you can find the sheet later with List exam answer sheets.
studentId is copied onto every answer and every piece of feedback, so send it if you want scores traceable to a student.

Want students to upload their own sheets? Create an embeddable UI link instead. It creates the answer sheet and a ready-made upload page in one call.

Next step

Upload an exam answer sheet

Attach the student’s pages, then submit them for evaluation.

Authorizations

Authorization

string

header

required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Path Parameters

examId

string<uuid>

required

The exam id returned by Create an exam. Write it in lowercase: this path only matches lowercase hexadecimal characters and hyphens.

Example:

"d19e6868-98dd-4274-a2a5-4a616dd93ea7"

Body

application/json

studentId

string

Your student reference. Stored as sent and copied onto every answer and feedback record.

Example:

"S-2043"

instituteId

string

Your school or institute reference.

Example:

"SCH-17"

teacherId

string

Your teacher reference.

Example:

"T-1042"

studentName

string

Example:

"Aarav Sharma"

parentId

string

Your parent reference.

Example:

"P-9981"

Response

The answer sheet was created.

One student's answer sheet. It never reports a status of its own.

string<uuid>

The answer sheet ID.

documents

object[]

Files attached to the answer sheet, oldest first.

Show child attributes

studentId

string | null

Your own student reference.

instituteId

string | null

Your own school or institute reference.

teacherId

string | null

Your own teacher reference.

studentName

string | null

parentId

string | null

Your own parent reference.

Create an exam answer sheet

curl --request POST \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentId": "S-2043",
  "instituteId": "SCH-17",
  "teacherId": "T-1042",
  "studentName": "Aarav Sharma",
  "parentId": "P-9981"
}
'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/"

payload = {
    "studentId": "S-2043",
    "instituteId": "SCH-17",
    "teacherId": "T-1042",
    "studentName": "Aarav Sharma",
    "parentId": "P-9981"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    studentId: 'S-2043',
    instituteId: 'SCH-17',
    teacherId: 'T-1042',
    studentName: 'Aarav Sharma',
    parentId: 'P-9981'
  })
};

fetch('https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b",
  "documents": [],
  "studentId": "S-2043",
  "instituteId": "SCH-17",
  "teacherId": "T-1042",
  "studentName": "Aarav Sharma",
  "parentId": "P-9981"
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Create an exam answer sheet

Rules

Next step

Upload an exam answer sheet

Authorizations

Path Parameters

Body

Response

​Rules

​Next step

Upload an exam answer sheet

Authorizations

Path Parameters

Body

Response

Rules

Next step