GET - List Exam

The 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:

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.
Filtering Exams by Grade or Subject: Teachers can retrieve exams filtered by specific criteria like grade or subject to streamline their workflow.
Exam Status Monitoring: Coordinators can use this API to track the status of exams (e.g., in progress, completed) and act accordingly.
Populating a Student Portal: Students can view available exams based on their class and subject by leveraging the data retrieved from this API.

GET

evaluation-platform

exam

Retrieve Exams

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

{
  "count": 78,
  "pageSize": 10,
  "showing": "Page 1 of 8",
  "next": "{{base_url}}/evaluation-platform/v1/exam/?page=2",
  "previous": null,
  "data": [
    {
      "id": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
      "examName": "CBSE 10 – Mock Test",
      "overallDuration": "180",
      "grade": 10,
      "classSection": null,
      "subject": 1,
      "examType": 1,
      "examSet": "N/A",
      "documents": [
        {
          "id": "18eb7110-d280-451d-8437-e54fe5f12dac",
          "status": 2,
          "pageNo": null,
          "uploadTime": "2025-01-04T13:46:59.825883Z",
          "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Science_-_Mock_Test.pdf.pdf",
          "fileType": 1
        }
      ],
      "createdAt": "2025-01-04T13:45:57.743446Z",
      "modifiedAt": "2025-01-04T13:54:29.506106Z",
      "examDate": "2024-01-09",
      "isFinalPublish": false,
      "isProvisionalPublished": false
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

Successful Response

count

integer

Total number of exams available.

Example:

78

pageSize

integer

Number of items displayed per page.

Example:

10

showing

string

Current page display information.

Example:

"Page 1 of 8"

string<uri> | null

URL for the next page of results.

Example:

"{{base_url}}/evaluation-platform/v1/exam/?page=2"

string<uri> | null

URL for the previous page of results.

Example:

null

data

object[]

List of exams.

Show child attributes

data.id

string<uuid>

Unique identifier of the exam.

Example:

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

data.examName

string

Name of the exam.

Example:

"CBSE 10 – Mock Test"

data.overallDuration

string | null

Duration of the exam in minutes.

Example:

"180"

data.grade

integer

Grade level of the exam.

Example:

10

data.classSection

string | null

Class section if applicable.

Example:

null

data.subject

integer

Subject ID associated with the exam.

Example:

1

data.examType

integer

Type of exam.

Example:

1

data.examSet

string

Exam set details.

Example:

"N/A"

data.documents

object[]

List of associated documents.

Show child attributes

data.documents.id

string<uuid>

Unique identifier of the document.

Example:

"18eb7110-d280-451d-8437-e54fe5f12dac"

data.documents.status

integer

Status of the document.

Example:

2

data.documents.pageNo

integer | null

Page number if applicable.

Example:

null

data.documents.uploadTime

string<date-time>

Time when the document was uploaded.

Example:

"2025-01-04T13:46:59.825883Z"

data.documents.url

string<uri>

URL to access the document.

Example:

"https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Science_-_Mock_Test.pdf.pdf"

data.documents.fileType

integer

Type of the file uploaded.

Example:

1

data.createdAt

string<date-time>

Timestamp when the exam was created.

Example:

"2025-01-04T13:45:57.743446Z"

data.modifiedAt

string<date-time>

Timestamp when the exam was last modified.

Example:

"2025-01-04T13:54:29.506106Z"

data.examDate

string<date>

Date on which the exam is scheduled.

Example:

"2024-01-09"

data.isFinalPublish

boolean

Indicates if the exam is published as final.

Example:

false

data.isProvisionalPublished

boolean

Indicates if the exam is published provisionally.

Example:

false

GET - QuestionsThe Get Questions API retrieves detailed information about the sections, parent questions, and sub-questions of a specific exam. It includes metadata such as instructions, marks, and approval statuses. **Scenarios:** 1. **Reviewing AI-Extracted Exam Structure:** - A teacher uses this API to review the structured format of an exam after AI processes uploaded documents (triggered by the PATCH Exam API). - The API retrieves: - Sections: Names or labels for different parts of the exam (e.g., 'Section A'). - Parent Questions: Main questions in the exam. - Sub-Questions: Detailed breakdowns of multi-part questions. - Metadata: Instructions, marks allocation, and approval statuses for each question. - **Outcome:** The teacher reviews and finalizes the AI-extracted structure to ensure accuracy and completeness. <Tip> Want to receive automatic notifications when exam questions are processed? Set up webhooks to get real-time updates on question extraction. Check out the [Webhooks](/api-reference/endpoint/webhook/v1-get-webhook-template). </Tip>

⌘I

Retrieve Exams

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

{
  "count": 78,
  "pageSize": 10,
  "showing": "Page 1 of 8",
  "next": "{{base_url}}/evaluation-platform/v1/exam/?page=2",
  "previous": null,
  "data": [
    {
      "id": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
      "examName": "CBSE 10 – Mock Test",
      "overallDuration": "180",
      "grade": 10,
      "classSection": null,
      "subject": 1,
      "examType": 1,
      "examSet": "N/A",
      "documents": [
        {
          "id": "18eb7110-d280-451d-8437-e54fe5f12dac",
          "status": 2,
          "pageNo": null,
          "uploadTime": "2025-01-04T13:46:59.825883Z",
          "url": "https://cgfblob.blob.core.windows.net/ielts/evaluation/CBSE_10_Science_-_Mock_Test.pdf.pdf",
          "fileType": 1
        }
      ],
      "createdAt": "2025-01-04T13:45:57.743446Z",
      "modifiedAt": "2025-01-04T13:54:29.506106Z",
      "examDate": "2024-01-09",
      "isFinalPublish": false,
      "isProvisionalPublished": false
    }
  ]
}

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - List Exam

Authorizations

Response