POST - Exam

The POST /evaluation-platform/v1/exam endpoint allows you to create a new exam for a specific class, subject, and exam type. Once an exam is created successfully, it returns a unique examId and status.

This API allows a teacher to create a new exam for a specific class, subject, and exam type. The newly created exam is initially empty and can be configured further by associating documents or additional metadata.

Scenario: Creating a New Exam for a Class

A teacher needs to set up a new exam for ‘Class 10’ in the subject ‘Science’ and exam type ‘Pre Boards.’

The teacher uses this API to create an empty exam by providing the required class, subject, and exam type.

Response:

A unique examId (e.g., d19e6868-98dd-4274-a2a5-4a616dd93ea7) is returned.
The status field indicates that the exam creation was successful.

Next Steps:

The teacher can use the examId in subsequent APIs to upload relevant documents or configure the exam further

POST

evaluation-platform

exam

Create a new exam for a specific class, subject, and date.

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examName": "Mid-Term Exam",
  "grade": 10,
  "subject": 1,
  "examType": 1,
  "examSet": "A",
  "examDate": "2025-01-10",
  "classSection": "A"
}
'

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/"

payload = {
    "examName": "Mid-Term Exam",
    "grade": 10,
    "subject": 1,
    "examType": 1,
    "examSet": "A",
    "examDate": "2025-01-10",
    "classSection": "A"
}
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({
    examName: 'Mid-Term Exam',
    grade: 10,
    subject: 1,
    examType: 1,
    examSet: 'A',
    examDate: '2025-01-10',
    classSection: 'A'
  })
};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/', 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/",
  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([
    'examName' => 'Mid-Term Exam',
    'grade' => 10,
    'subject' => 1,
    'examType' => 1,
    'examSet' => 'A',
    'examDate' => '2025-01-10',
    'classSection' => 'A'
  ]),
  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/"

	payload := strings.NewReader("{\n  \"examName\": \"Mid-Term Exam\",\n  \"grade\": 10,\n  \"subject\": 1,\n  \"examType\": 1,\n  \"examSet\": \"A\",\n  \"examDate\": \"2025-01-10\",\n  \"classSection\": \"A\"\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/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"examName\": \"Mid-Term Exam\",\n  \"grade\": 10,\n  \"subject\": 1,\n  \"examType\": 1,\n  \"examSet\": \"A\",\n  \"examDate\": \"2025-01-10\",\n  \"classSection\": \"A\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/")

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  \"examName\": \"Mid-Term Exam\",\n  \"grade\": 10,\n  \"subject\": 1,\n  \"examType\": 1,\n  \"examSet\": \"A\",\n  \"examDate\": \"2025-01-10\",\n  \"classSection\": \"A\"\n}"

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

{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "documents": []
}

{
  "error": {
    "code": 400,
    "message": {
      "examSet": [
        "This field is required."
      ],
      "examDate": [
        "This field is required."
      ],
      "non_field_errors": [
        "Invalid value: 101. Must be one of [1]."
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

examName

string

required

Name of the exam

Example:

"Mid-Term Exam"

grade

integer

required

Class for which the exam is intended

Example:

10

subject

integer

required

Subject ID

Example:

1

examType

integer

required

Type of exam.

Example:

1

examSet

string

required

Set of the exam paper

Example:

"A"

examDate

string<date>

required

Date of the exam (should be in the format format - 'YYYY-MM-DD')

Example:

"2025-01-10"

classSection

string

Optional section of the class

Example:

"A"

Response

Exam created successfully.

examId

string

Unique identifier of the exam

Example:

"4340132f-50fa-4877-9ffa-e9b7ee59d51f"

documents

object[]

An empty array to attach further content.

Show child attributes

Example:

[]

Create a new exam for a specific class, subject, and date.

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "examName": "Mid-Term Exam",
  "grade": 10,
  "subject": 1,
  "examType": 1,
  "examSet": "A",
  "examDate": "2025-01-10",
  "classSection": "A"
}
'

import requests

url = "https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/"

payload = {
    "examName": "Mid-Term Exam",
    "grade": 10,
    "subject": 1,
    "examType": 1,
    "examSet": "A",
    "examDate": "2025-01-10",
    "classSection": "A"
}
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({
    examName: 'Mid-Term Exam',
    grade: 10,
    subject: 1,
    examType: 1,
    examSet: 'A',
    examDate: '2025-01-10',
    classSection: 'A'
  })
};

fetch('https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/', 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/",
  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([
    'examName' => 'Mid-Term Exam',
    'grade' => 10,
    'subject' => 1,
    'examType' => 1,
    'examSet' => 'A',
    'examDate' => '2025-01-10',
    'classSection' => 'A'
  ]),
  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/"

	payload := strings.NewReader("{\n  \"examName\": \"Mid-Term Exam\",\n  \"grade\": 10,\n  \"subject\": 1,\n  \"examType\": 1,\n  \"examSet\": \"A\",\n  \"examDate\": \"2025-01-10\",\n  \"classSection\": \"A\"\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/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"examName\": \"Mid-Term Exam\",\n  \"grade\": 10,\n  \"subject\": 1,\n  \"examType\": 1,\n  \"examSet\": \"A\",\n  \"examDate\": \"2025-01-10\",\n  \"classSection\": \"A\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/")

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  \"examName\": \"Mid-Term Exam\",\n  \"grade\": 10,\n  \"subject\": 1,\n  \"examType\": 1,\n  \"examSet\": \"A\",\n  \"examDate\": \"2025-01-10\",\n  \"classSection\": \"A\"\n}"

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

{
  "examId": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
  "documents": []
}

{
  "error": {
    "code": 400,
    "message": {
      "examSet": [
        "This field is required."
      ],
      "examDate": [
        "This field is required."
      ],
      "non_field_errors": [
        "Invalid value: 101. Must be one of [1]."
      ]
    }
  }
}

{
  "detail": "Token has expired"
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

POST - Exam

Authorizations

Body

Response