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"
}
'

import requests

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

payload = {
    "studentId": "2017009807",
    "instituteId": "98765",
    "teacherId": "54321",
    "studentName": "John Doe",
    "parentId": "11223"
}
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: '2017009807',
    instituteId: '98765',
    teacherId: '54321',
    studentName: 'John Doe',
    parentId: '11223'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'studentId' => '2017009807',
    'instituteId' => '98765',
    'teacherId' => '54321',
    'studentName' => 'John Doe',
    'parentId' => '11223'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": "Token has expired"
}

{
  "error:": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Exam not found"
      ]
    }
  }
}

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

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"

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"
}
'

import requests

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

payload = {
    "studentId": "2017009807",
    "instituteId": "98765",
    "teacherId": "54321",
    "studentName": "John Doe",
    "parentId": "11223"
}
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: '2017009807',
    instituteId: '98765',
    teacherId: '54321',
    studentName: 'John Doe',
    parentId: '11223'
  })
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'studentId' => '2017009807',
    'instituteId' => '98765',
    'teacherId' => '54321',
    'studentName' => 'John Doe',
    'parentId' => '11223'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"studentId\": \"2017009807\",\n  \"instituteId\": \"98765\",\n  \"teacherId\": \"54321\",\n  \"studentName\": \"John Doe\",\n  \"parentId\": \"11223\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": "Token has expired"
}

{
  "error:": {
    "code": 400,
    "message": {
      "non_field_errors": [
        "Exam not found"
      ]
    }
  }
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

POST - Student Answer Sheet

Authorizations

Path Parameters

Body

Response