> ## 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 - Student Answer Sheet List

> The API retrieves details about all the student answer sheet for a specific exam, including its metadata and associated documents. These documents can either be: 

 - A single PDF file, or 
 - Multiple images (JPEG), each with a specific sequence. 

**Scenarios:**

1. **Reviewing All Student Answer Sheets for an Exam:**
   - A teacher or administrator needs to access and review all student answer sheets for a given exam.
   - **API Fetches:**
     - Metadata such as student IDs, and timestamps.
     - Associated documents (PDF or JPEG images).
   - **Outcome:**
     - The teacher can easily access and evaluate the answer sheets for all students, ensuring they are ready for grading or review.

2. **Validating the Submission Status of Student Answer Sheets:**
   - A content moderator or administrator needs to validate whether all answer sheets for a given exam have been submitted.
   - **API Returns:**
     - Metadata for each student’s answer sheet, including submission status and file type (PDF or JPEG).
   - **Outcome:**
     - The administrator confirms the submission status and checks the completeness and consistency of the submitted documents.



<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/yciB3oRiYYY"
    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>

**Video Link -** [https://youtu.be/yciB3oRiYYY?si=HUIop\_zs5sFjYoUW](https://youtu.be/yciB3oRiYYY?si=HUIop_zs5sFjYoUW)


## OpenAPI

````yaml GET /evaluation-platform/v1/exam/{examId}/answer-sheet/
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/{examId}/answer-sheet/:
    get:
      parameters:
        - in: path
          name: examId
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successfully Retrieved Data
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Array of student answers sheets along with documents
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier of the student answer sheet
                          example: cec7fcaa-9cef-4d5b-8aff-297a022f6666
                        documents:
                          type: array
                          description: >-
                            List of documents associated with the student answer
                            sheet
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Unique identifier of the document
                                example: 10d5661d-df3a-4d22-aa58-fddfa1230040
                              status:
                                type: integer
                                description: Status of the document
                                example: 1
                              pageNo:
                                type: integer
                                description: Page number of the document
                                example: 1
                              uploadTime:
                                type: string
                                description: Time of document upload
                                example: '2025-01-06T12:28:22.992639Z'
                              url:
                                type: string
                                description: URL of the document
                                example: >-
                                  https://cgfblob.blob.core.windows.net/ielts/evaluation/2017009807.pdf
                              fileType:
                                type: integer
                                description: Type of the document
                                example: 1
                          example:
                            - id: 10d5661d-df3a-4d22-aa58-fddfa1230040
                              status: 1
                              pageNo: null
                              uploadTime: '2025-01-06T12:28:22.992639Z'
                              url: >-
                                https://cgfblob.blob.core.windows.net/ielts/evaluation/2017009807.pdf
                              fileType: 1
                        studentId:
                          type: string
                          description: Unique identifier of the student
                          example: '2017009807'
                        instituteId:
                          type: string
                          description: Unique identifier of the institute
                          example: '98765'
                        teacherId:
                          type: string
                          description: Unique identifier of the teacher
                          example: '54321'
                        studentName:
                          type: string
                          description: Name of the student
                          example: John Doe
                        parentId:
                          type: string
                          description: Unique identifier of the parent
                          example: '11223'
                      example:
                        id: cec7fcaa-9cef-4d5b-8aff-297a022f6666
                        documents: []
                example:
                  data:
                    - id: cec7fcaa-9cef-4d5b-8aff-297a022f6666
                      documents: []
                      studentId: ''
                      instituteId: ''
                      teacherId: ''
                      studentName: ''
                      parentId: ''
                    - id: 946c75fe-12a6-4868-bf59-9ee12527263f
                      studentId: '2017009807'
                      instituteId: '98765'
                      teacherId: '54321'
                      studentName: John Doe
                      parentId: '11223'
                      documents:
                        - id: 10d5661d-df3a-4d22-aa58-fddfa1230040
                          status: 1
                          pageNo: null
                          uploadTime: '2025-01-06T12:28:22.992639Z'
                          url: >-
                            https://cgfblob.blob.core.windows.net/ielts/evaluation/2017009807.pdf
                          fileType: 1
        '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: Bad Request - Answer sheet not evaluated
          content:
            application/json:
              schema:
                type: object
                properties:
                  'error:':
                    type: object
                    properties:
                      code:
                        type: integer
                        example: 400
                      message:
                        type: object
                        properties:
                          non_field_errors:
                            type: array
                            items:
                              type: string
                              example: Exam not found
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````