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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

{
  "detail": "Token has expired"
}

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

Video Link - https://youtu.be/yciB3oRiYYY?si=HUIop_zs5sFjYoUW

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

cURL

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

{
  "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

GET - Student Answer Sheet List

Authorizations

Path Parameters

Response