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

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

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

Authorizations

Authorization

string

header

required

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

Body

application/json

Response

201

application/json

Exam created successfully.

The response is of type object.

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

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

POST - Exam

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

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

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

Authorizations

Authorization

string

header

required

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

Body

application/json

Response

201

application/json

Exam created successfully.

The response is of type object.

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

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

POST - Exam

Authorizations

Body

Response

Authentication

K12

Assessment Rubrics

Standardized Language Exams

POST - Exam

Authorizations

Body

Response