GET - Exam Detail

The Exam Details API allows you to retrieve detailed information about a specific exam, including metadata such as the exam’s name, type, attached documents, and what is the status of the documents.

Use Cases:

Populate Admin Dashboards: Admins can use this API to fetch detailed exam information to display on dashboards, including metadata, documents, and publication statuses.
Generate Reports: Backend services can use this API to generate reports for audits or analytics based on exam metadata and documents.
Access Attached Documents: Developers can access the attached documents’ URLs to display or download PDFs/images.

GET

evaluation-platform

exam

{id}

Get exam details by ID.

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

import requests

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

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/{id}/', 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/{id}/",
  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/{id}/"

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

}

HttpResponse<String> response = Unirest.get("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "id": "d19e8688-98dd-4274-a2a5-4a616dd93ea7",
  "examName": "Mock Test",
  "overallDuration": 180,
  "grade": 10,
  "classSection": null,
  "subject": 1,
  "examType": 1,
  "examSet": "N/A",
  "documents": [
    {
      "id": "d24b29ff-d3e4-4dab-9218-20b9a472c7e0",
      "status": 2,
      "pageNo": null,
      "uploadTime": "2024-12-23T12:50:59.181071Z",
      "url": "https://cfgblob.blob.core.windows.net/evaluation/CBSE_10_Science_-_Mock_Test_A.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2024-12-23T12:50:39.786489Z",
  "modifiedAt": "2024-12-26T06:52:14.633272Z",
  "examDate": "2024-08-10",
  "isFinalPublish": false,
  "isProvisionalPublished": false
}

{
  "detail": "Token has expired"
}

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Example:

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

Response

Successful Response

string<uuid>

Unique identifier of the exam.

Example:

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

examName

string

Name of the exam.

Example:

"Mock Test"

overallDuration

integer

Duration of the exam in minutes.

Example:

180

grade

integer

Class for which the exam is designed.

Example:

10

classSection

string | null

Section of the class, if applicable.

Example:

null

subject

integer

Subject ID associated with the exam.

Example:

1

examType

integer

Type of the exam.

Example:

1

examSet

string

Exam set information.

Example:

"N/A"

documents

object[]

List of documents associated with the exam.

Show child attributes

createdAt

string<date-time>

Timestamp of exam creation.

Example:

"2024-12-23T12:50:39.786489Z"

modifiedAt

string<date-time>

Timestamp of the last modification.

Example:

"2024-12-26T06:52:14.633272Z"

examDate

string<date>

Date of the exam.

Example:

"2024-08-10"

isFinalPublish

boolean

Whether the exam is finalized for publication.

Example:

false

isProvisionalPublished

boolean

Whether the exam is provisionally published.

Example:

false

GET - List ExamThe GET /evaluation-platform/v1/exam API retrieves a paginated list of exams, providing detailed information about each exam, including associated documents, grades, subjects, and other metadata. **Scenarios:** 1. **Displaying Exams on an Admin Dashboard:** Admins can use this API to fetch and display a list of exams with relevant details for monitoring and management. 2. **Filtering Exams by Grade or Subject:** Teachers can retrieve exams filtered by specific criteria like grade or subject to streamline their workflow. 3. **Exam Status Monitoring:** Coordinators can use this API to track the status of exams (e.g., in progress, completed) and act accordingly. 4. **Populating a Student Portal:** Students can view available exams based on their class and subject by leveraging the data retrieved from this API.

Get exam details by ID.

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

import requests

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

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/{id}/', 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/{id}/",
  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/{id}/"

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

}

HttpResponse<String> response = Unirest.get("https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "id": "d19e8688-98dd-4274-a2a5-4a616dd93ea7",
  "examName": "Mock Test",
  "overallDuration": 180,
  "grade": 10,
  "classSection": null,
  "subject": 1,
  "examType": 1,
  "examSet": "N/A",
  "documents": [
    {
      "id": "d24b29ff-d3e4-4dab-9218-20b9a472c7e0",
      "status": 2,
      "pageNo": null,
      "uploadTime": "2024-12-23T12:50:59.181071Z",
      "url": "https://cfgblob.blob.core.windows.net/evaluation/CBSE_10_Science_-_Mock_Test_A.pdf",
      "fileType": 1
    }
  ],
  "createdAt": "2024-12-23T12:50:39.786489Z",
  "modifiedAt": "2024-12-26T06:52:14.633272Z",
  "examDate": "2024-08-10",
  "isFinalPublish": false,
  "isProvisionalPublished": false
}

{
  "detail": "Token has expired"
}

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