> ## 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 - Provisional Mark Sheet

>  The API retrieves detailed provisional scores for a student's exam. This includes:

 - Exam-level metadata (exam name, subject, total marks, etc.). 
 - Section-wise summaries (marks distribution and instructions). 
 - Detailed breakdown of student answers, model answers, step-wise marking, and feedback. 

This API helps educators review scores and provide feedback before finalizing and publishing results. 

**Scenarios:**

1. **Reviewing Provisional Scores Before Finalizing:**
   - A teacher reviews the provisional scores of a specific student before finalizing the results.
   - The API provides:
     - **Exam-Level Metadata:** Information like exam name, subject, and total marks.
     - **Section-Wise Summaries:** Breakdown of marks distribution and instructions for each section.
     - **Detailed Breakdown:** Student answers, model answers, step-wise marking, and feedback for each question.
   - **Outcome:**
     - The teacher reviews the provisional scores, adjusts as needed, and prepares to finalize the results for publication.

2. **Providing Feedback on Provisional Scores:**
   - A teacher uses this API to review and give feedback on provisional scores for a specific exam.
   - The teacher can access detailed performance information, including step-wise marking and feedback.
   - **Outcome:**
     - The teacher offers personalized feedback to students, helping them understand their mistakes and providing guidance for improvement before results are finalized.






## OpenAPI

````yaml GET /evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/provisional-scores/
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/{ansSheetId}/provisional-scores/:
    get:
      summary: Retrieve provisional scores for an answer sheet
      description: Retrieve provisional scores for an answer sheet
      parameters:
        - in: path
          name: examId
          schema:
            type: string
          required: true
        - name: ansSheetId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Status of the response
                    example: success
                  provisionalPublishedDate:
                    type: string
                    description: Date and time when the provisional scores were published
                    format: date-time
                    example: '2024-12-26 05:58:55'
                  data:
                    $ref: '#/components/schemas/scores'
                    description: Data containing the provisional scores
        '400':
          description: Bad Request
          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:
                              - >-
                                Provisional scores for this exam are not
                                published yet
                example:
                  error:
                    code: 400
                    message:
                      non_field_errors:
                        - Provisional scores for this exam are not published yet
        '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
          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: Answer Sheet not found
      security:
        - bearerAuth: []
components:
  schemas:
    scores:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the exam.
          example: 4340132f-50fa-4877-9ffa-e9b7ee59d51f
        examName:
          type: string
          description: Name of the exam.
          example: CBSE 10 – Mock Test
        subjectName:
          type: string
          description: Name of the subject.
          example: Science
        totalMarks:
          type: number
          description: Total marks for the exam.
          format: float
          example: 80
        obtainedMarks:
          type: number
          description: Marks obtained by the student.
          format: float
          example: 45
        questionMarkSumMismatch:
          type: boolean
          description: >-
            Flag to indicate if the sum of the marks of the questions is not
            equal to the total marks of the exam
          example: false
        modelAnswerMarkSumMismatch:
          type: boolean
          description: >-
            Flag to indicate if the sum of the marks of the model answers is not
            equal to the total marks of the exam
          example: false
        overallDuration:
          type: string
          description: Total duration of the exam.
          example: '180'
        overallInstruction:
          type: string
          description: General instructions for the exam.
          example: >-
            1. All questions would be compulsory. However, an internal choice of
            approximately 33% would be provided. 50% marks are to be allotted to
            competency-based questions. 2. Section A would have 16
            simple/complex MCQs and 04 Assertion-Reasoning type questions
            carrying 1 mark each. 3. Section B would have 6 Short Answer (SA)
            type questions carrying 02 marks each. 4. Section C would have 7
            Short Answer (SA) type questions carrying 03 marks each. 5. Section
            D would have 3 Long Answer (SA) type questions carrying 05 marks
            each. 6. Section E would have 3 source based/case based/passage
            based/integrated units of assessment (04 marks each) with sub-parts
            of the values of 1/2/3 marks.
        sections:
          type: array
          description: List of sections in the exam.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the section.
                example: ef66afc6-d923-43c6-b2d2-e29814306214
              sectionName:
                type: string
                description: Name of the section.
                example: SECTION A
              duration:
                type: string
                description: Duration of the section.
                example: null
              instruction:
                type: string
                description: Instructions for the section.
                example: null
              totalMarks:
                type: number
                description: Total marks for the section.
                format: float
                example: 20
              obtainedMarks:
                type: number
                description: Marks obtained by the student in the section.
                format: float
                example: 13
              parentQuestions:
                type: array
                description: List of parent questions in the section.
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier for the parent question.
                      example: fcb22595-c36a-4ddf-b9d3-00ba6d2ea466
                    text:
                      type: string
                      description: Text of the parent question.
                      example: >-
                        Identify the option that indicates the correct enzyme
                        that is secreted in location i, ii and iii.
                    marks:
                      type: integer
                      description: Marks assigned to the parent question.
                      example: 1
                    questionNumber:
                      type: string
                      description: Number of the parent question.
                      example: Q1
                    diagramDescription:
                      type: string
                      description: >-
                        Description of the diagram associated with the parent
                        question.
                      example: null
                    questionType:
                      type: string
                      description: Type of the parent question.
                      example: MCQ
                    questions:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 226986d3-95e4-4ed7-aaa4-3e7054f9bc5b
                          text:
                            type: string
                            example: >-
                              (a) (i)Lipase, (ii) trypsin (iii) pepsin (b) (i)
                              amylase, (ii) pepsin, (iii) trypsin (c) (i)
                              trypsin, (ii) amylase, (iii) carboxylase (d) (i)
                              permease (ii) carboxylase (iii) oxidase
                          marks:
                            type: number
                            format: float
                            example: 1
                          isApproved:
                            type: boolean
                            example: false
                          questionNumber:
                            type: string
                            example: ''
                          supportingText:
                            type: string
                            example: MCQ
                          modelAnswer:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 57837640-c695-44a5-9667-9cfb8bafebf1
                              answerText:
                                type: string
                                example: ''
                              stepMarking:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    marksplit:
                                      type: number
                                      example: 1
                                    step_wise_answer:
                                      type: string
                                      example: >-
                                        (b) (i) amylase, (ii) pepsin, (iii)
                                        trypsin
                                    modelanswer_diagram_description:
                                      type: string
                                      example: ''
                          answer:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: f819bfd2-8aaa-42df-bd18-23cb989b2d16
                                answerText:
                                  type: string
                                  example: (b) (i) amylase , (ii) pepsin, (iii) Trypsin
                                marks:
                                  type: number
                                  format: float
                                  example: 1
                                isApproved:
                                  type: boolean
                                  example: false
                                diagramDescription:
                                  type: string
                                  example: null
                                aiFeedbacks:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      feedback:
                                        type: string
                                        example: >-
                                          The student has provided the correct
                                          answer, demonstrating a clear
                                          understanding of the enzymes associated
                                          with the specified locations. Great job!
                                      student_text:
                                        type: string
                                        example: >-
                                          (b) (i) amylase , (ii) pepsin, (iii)
                                          Trypsin
                                      justification:
                                        type: string
                                        example: >-
                                          The student's answer matches the model
                                          answer exactly, indicating that they
                                          have correctly identified the enzymes
                                          for each location as per the question
                                          requirements.
                                      marks_deducted:
                                        type: string
                                        example: '0'
                                      room_for_improvement:
                                        type: string
                                        example: >-
                                          None, as the answer is correct and
                                          complete.
                                teacherFeedback:
                                  type: string
                                  example: >-
                                    The student has provided the correct answer,
                                    demonstrating a clear understanding of the
                                    enzymes associated with the specified
                                    locations. Great job!
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````