> ## 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.

# LIST - Assignment

>  This API allows authenticated users to retrieve a paginated list of assignments along with associated metadata like total count, pagination links, and assignment details.


 **Key Notes:** 
 - The response includes `count`, `pageSize`, `showing`, `next`, and `previous` to handle pagination. 
 - The `data` field contains an array of assignment objects following the `UpdatedAssignmentResponse` schema. 
 - Useful for dashboards or any view where a user needs to browse or manage multiple assignments.


 **Scenario: Fetching Assignments for Review** 
 - A teacher wants to review all assignments created for Grade 7. 
 - They send a GET request to this endpoint (optionally with query parameters for filtering/pagination). 
 - The system responds with a paginated list of assignments and relevant navigation links. 



## OpenAPI

````yaml GET /assignment-evaluation/v1/assignment/
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:
  /assignment-evaluation/v1/assignment/:
    get:
      tags:
        - Assignments
      summary: Get Assignment List
      operationId: getAssignmentList
      responses:
        '200':
          description: List of assignments retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 20
                    description: Total number of assignments available.
                  pageSize:
                    type: integer
                    example: 10
                    description: Number of items displayed per page.
                  showing:
                    type: string
                    example: Page 1 of 2
                    description: Current page display information.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    example: '{{base_url}}/assignment-evaluation/v1/assignment/?page=2'
                    description: URL for the next page of results.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    example: null
                    description: URL for the previous page of results.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UpdatedAssignmentResponse'
        '403':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403Response'
        '404':
          description: Page not found or invalid page number.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: Invalid page.
      security:
        - bearerAuth: []
components:
  schemas:
    UpdatedAssignmentResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 2600413f-7c6e-46ef-8ea9-3e7b5834879f
          description: Unique identifier for the assignment.
        assignmentName:
          type: string
          example: English Assignment
          description: Name of the assignment.
        status:
          type: integer
          example: 2
          description: >-
            Status of the assignment [(refer this doc to get the
            constants)](https://docs.crazygoldfish.com/api-reference/endpoint/assignments/v1-constants)
        grade:
          type: string
          example: '7'
          description: Grade of the assignment.
        marks:
          nullable: true
          type: integer
          example: 10
        section:
          type: string
          example: A
          description: Section of the assignment.
        parentInstituteId:
          type: string
          example: '100'
          description: ID of the parent institute.
        instituteId:
          type: string
          example: '200'
          description: ID of the institute.
        courseId:
          type: string
          example: '300'
          description: ID of the course.
        documents:
          type: array
          description: List of documents associated with the assignment.
          items:
            $ref: '#/components/schemas/AssignmentDocument'
        createdAt:
          type: string
          format: date-time
          example: '2025-04-06T09:03:42.099207Z'
          description: Created date for the assignment.
        modifiedAt:
          type: string
          format: date-time
          example: '2025-04-06T09:06:19.351379Z'
          description: Modified date of the assignment.
    403Response:
      type: object
      properties:
        detail:
          type: string
          example: Token has expired
    AssignmentDocument:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: bec0d0bf-fff6-40de-9750-65f5dcaf470d
          description: Unique identifier for the document.
        status:
          type: integer
          example: 1
          description: Status of the document.
        pageNo:
          nullable: true
          type: integer
          example: 1
        uploadTime:
          type: string
          format: date-time
          example: '2025-04-06T09:04:11.716434Z'
          description: Upload time of the document.
        url:
          type: string
          format: uri
          example: >-
            https://cgfblob.blob.core.windows.net/documents/assignment-evaluation/olfactory_imagery_HW_PDF_2_questions_1_H7dPCAd.pdf
          description: URL of the document.
        fileType:
          type: integer
          example: 1
          description: Type of the file.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````