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.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
"4340132f-50fa-4877-9ffa-e9b7ee59d51f"
Response
Unique identifier of the exam.
"d19e8688-98dd-4274-a2a5-4a616dd93ea7"
Name of the exam.
"Mock Test"
Duration of the exam in minutes.
180
Class for which the exam is designed.
10
Section of the class, if applicable.
null
Subject ID associated with the exam.
1
Type of the exam.
1
Exam set information.
"N/A"
List of documents associated with the exam.
Timestamp of exam creation.
"2024-12-23T12:50:39.786489Z"
Timestamp of the last modification.
"2024-12-26T06:52:14.633272Z"
Date of the exam.
"2024-08-10"
Whether the exam is finalized for publication.
false
Whether the exam is provisionally published.
false