> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crazygoldfish.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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:**
1. **Populate Admin Dashboards:** Admins can use this API to fetch detailed exam information to display on dashboards, including metadata, documents, and publication statuses. 
2. **Generate Reports:** Backend services can use this API to generate reports for audits or analytics based on exam metadata and documents. 
3. **Access Attached Documents:** Developers can access the attached documents' URLs to display or download PDFs/images.

<div
  style={{
background: 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)',
borderRadius: '16px',
padding: '4px',
marginTop: '20px',
marginBottom: '20px',
boxShadow: '0 10px 40px rgba(102, 126, 234, 0.3)'
}}
>
  <iframe
    className="w-full aspect-video rounded-xl"
    src="https://www.youtube.com/embed/o1hHLtI3x4s"
    title="Evaluation Platform | GET | API Reference Guide"
    frameBorder="0"
    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
    allowFullScreen
    style={{
  borderRadius: '12px',
  boxShadow: '0 4px 6px rgba(0, 0, 0, 0.1)'
}}
  />
</div>


## OpenAPI

````yaml GET /evaluation-platform/v1/exam/{id}/
openapi: 3.0.1
info:
  title: Evaluation Report API
  description: An API for retrieving evaluation reports.
  version: 1.0.0
servers:
  - url: https://api-staging.crazygoldfish.com
    description: SandBox endpoint
  - url: https://api.crazygoldfish.com
    description: Prod End Point
security: []
paths:
  /evaluation-platform/v1/exam/{id}/:
    get:
      summary: Get exam details by ID.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: 4340132f-50fa-4877-9ffa-e9b7ee59d51f
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    example: d19e8688-98dd-4274-a2a5-4a616dd93ea7
                    description: Unique identifier of the exam.
                  examName:
                    type: string
                    example: Mock Test
                    description: Name of the exam.
                  overallDuration:
                    type: integer
                    example: 180
                    description: Duration of the exam in minutes.
                  grade:
                    type: integer
                    example: 10
                    description: Class for which the exam is designed.
                  classSection:
                    type: string
                    nullable: true
                    example: null
                    description: Section of the class, if applicable.
                  subject:
                    type: integer
                    example: 1
                    description: Subject ID associated with the exam.
                  examType:
                    type: integer
                    example: 1
                    description: Type of the exam.
                  examSet:
                    type: string
                    example: N/A
                    description: Exam set information.
                  documents:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          example: d24b29ff-d3e4-4dab-9218-20b9a472c7e0
                          description: Unique identifier of the document.
                        status:
                          type: integer
                          example: 2
                          description: Status of the document.
                        pageNo:
                          type: integer
                          nullable: true
                          example: null
                          description: Page number if applicable.
                        uploadTime:
                          type: string
                          format: date-time
                          example: '2024-12-23T12:50:59.181071Z'
                          description: Time of document upload.
                        url:
                          type: string
                          format: uri
                          example: >-
                            https://cfgblob.blob.core.windows.net/evaluation/CBSE_10_Science_-_Mock_Test_A.pdf
                          description: URL of the document.
                        fileType:
                          type: integer
                          example: 1
                          description: File type identifier.
                    description: List of documents associated with the exam.
                  createdAt:
                    type: string
                    format: date-time
                    example: '2024-12-23T12:50:39.786489Z'
                    description: Timestamp of exam creation.
                  modifiedAt:
                    type: string
                    format: date-time
                    example: '2024-12-26T06:52:14.633272Z'
                    description: Timestamp of the last modification.
                  examDate:
                    type: string
                    format: date
                    example: '2024-08-10'
                    description: Date of the exam.
                  isFinalPublish:
                    type: boolean
                    example: false
                    description: Whether the exam is finalized for publication.
                  isProvisionalPublished:
                    type: boolean
                    example: false
                    description: Whether the exam is provisionally published.
        '403':
          description: Authentication failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Token has expired
              example:
                detail: Token has expired
        '404':
          description: Exam not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        example: 404
                        description: HTTP status code for the error.
                      message:
                        type: object
                        properties:
                          non_field_errors:
                            type: array
                            items:
                              type: string
                              example: Exam not found
                            description: List of non-field-specific error messages.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````