GET - Final Result

The API retrieves the finalized scores and detailed performance breakdown for a student’s exam. This includes:

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

Scenarios:

Retrieving Finalized Scores After Exam Results Are Published:
- After the exam results are finalized and published, the teacher or administrator retrieves the finalized scores for a student.
- The API provides:
  - Exam-Level Metadata: Information such as exam name, subject, total marks, and any other relevant details.
  - Section-Wise Summaries: Marks distribution, section-specific instructions, and total allocated marks for each section.
  - Detailed Breakdown: Student’s answers, model answers, step-wise marking, and feedback.
- Outcome:
  - The finalized scores provide a comprehensive overview of the student’s performance, which can be shared with students and used for reporting purposes.
Reviewing Detailed Feedback After Exam Results Are Finalized:
- A teacher uses the API to review the student’s finalized scores, including step-wise marking, feedback, and model answers.
- Outcome:
  - Teachers can analyze student responses in comparison to model answers, providing feedback and personalized academic counseling to help students identify strengths and areas for improvement.

GET

evaluation-platform

exam

{examId}

answer-sheet

{ansSheetId}

get-final-result

Retrieve final scores for an answer sheet

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/get-final-result/ \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "publishedDate": "2024-12-26 09:58:30",
  "data": {
    "id": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
    "examName": "CBSE 10 – Mock Test",
    "subjectName": "Science",
    "totalMarks": 80,
    "obtainedMarks": 45,
    "questionMarkSumMismatch": false,
    "modelAnswerMarkSumMismatch": false,
    "overallDuration": "180",
    "overallInstruction": "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": [
      {
        "id": "ef66afc6-d923-43c6-b2d2-e29814306214",
        "sectionName": "SECTION A",
        "duration": null,
        "instruction": null,
        "totalMarks": 20,
        "obtainedMarks": 13,
        "parentQuestions": [
          {
            "id": "fcb22595-c36a-4ddf-b9d3-00ba6d2ea466",
            "text": "Identify the option that indicates the correct enzyme that is secreted in location i, ii and iii.",
            "marks": 1,
            "questionNumber": "Q1",
            "diagramDescription": null,
            "questionType": "MCQ",
            "questions": [
              {
                "id": "226986d3-95e4-4ed7-aaa4-3e7054f9bc5b",
                "text": "(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": 1,
                "isApproved": false,
                "questionNumber": "",
                "supportingText": "MCQ",
                "modelAnswer": {
                  "id": "57837640-c695-44a5-9667-9cfb8bafebf1",
                  "answerText": "",
                  "stepMarking": [
                    {
                      "marksplit": 1,
                      "step_wise_answer": "(b) (i) amylase, (ii) pepsin, (iii) trypsin",
                      "modelanswer_diagram_description": ""
                    }
                  ]
                },
                "answer": [
                  {
                    "id": "f819bfd2-8aaa-42df-bd18-23cb989b2d16",
                    "answerText": "(b) (i) amylase , (ii) pepsin, (iii) Trypsin",
                    "marks": 1,
                    "isApproved": false,
                    "diagramDescription": null,
                    "aiFeedbacks": [
                      {
                        "feedback": "The student has provided the correct answer, demonstrating a clear understanding of the enzymes associated with the specified locations. Great job!",
                        "student_text": "(b) (i) amylase , (ii) pepsin, (iii) Trypsin",
                        "justification": "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": "0",
                        "room_for_improvement": "None, as the answer is correct and complete."
                      }
                    ],
                    "teacherFeedback": "The student has provided the correct answer, demonstrating a clear understanding of the enzymes associated with the specified locations. Great job!"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

examId

string

required

ansSheetId

string

required

Response

Success

status

string

Status of the response

Example:

"success"

publishedDate

string<date-time>

Date and time when the final scores were published

Example:

"2024-12-26 09:58:30"

data

object

The final scores for the answer sheet

Show child attributes

data.id

string

Unique identifier for the exam.

Example:

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

data.examName

string

Name of the exam.

Example:

"CBSE 10 – Mock Test"

data.subjectName

string

Name of the subject.

Example:

"Science"

data.totalMarks

number<float>

Total marks for the exam.

Example:

80

data.obtainedMarks

number<float>

Marks obtained by the student.

Example:

45

data.questionMarkSumMismatch

boolean

Flag to indicate if the sum of the marks of the questions is not equal to the total marks of the exam

Example:

false

data.modelAnswerMarkSumMismatch

boolean

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

data.overallDuration

string

Total duration of the exam.

Example:

"180"

data.overallInstruction

string

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

data.sections

object[]

List of sections in the exam.

Show child attributes

data.sections.id

string

Unique identifier for the section.

Example:

"ef66afc6-d923-43c6-b2d2-e29814306214"

data.sections.sectionName

string

Name of the section.

Example:

"SECTION A"

data.sections.duration

string

Duration of the section.

Example:

null

data.sections.instruction

string

Instructions for the section.

Example:

null

data.sections.totalMarks

number<float>

Total marks for the section.

Example:

20

data.sections.obtainedMarks

number<float>

Marks obtained by the student in the section.

Example:

13

data.sections.parentQuestions

object[]

List of parent questions in the section.

Show child attributes

data.sections.parentQuestions.id

string

Unique identifier for the parent question.

Example:

"fcb22595-c36a-4ddf-b9d3-00ba6d2ea466"

data.sections.parentQuestions.text

string

Text of the parent question.

Example:

"Identify the option that indicates the correct enzyme that is secreted in location i, ii and iii."

data.sections.parentQuestions.marks

integer

Marks assigned to the parent question.

Example:

1

data.sections.parentQuestions.questionNumber

string

Number of the parent question.

Example:

"Q1"

data.sections.parentQuestions.diagramDescription

string

Description of the diagram associated with the parent question.

Example:

null

data.sections.parentQuestions.questionType

string

Type of the parent question.

Example:

"MCQ"

data.sections.parentQuestions.questions

object[]

Show child attributes

data.sections.parentQuestions.questions.id

string

Example:

"226986d3-95e4-4ed7-aaa4-3e7054f9bc5b"

data.sections.parentQuestions.questions.text

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"

data.sections.parentQuestions.questions.marks

number<float>

Example:

1

data.sections.parentQuestions.questions.isApproved

boolean

Example:

false

data.sections.parentQuestions.questions.questionNumber

string

Example:

""

data.sections.parentQuestions.questions.supportingText

string

Example:

"MCQ"

data.sections.parentQuestions.questions.modelAnswer

object

Show child attributes

data.sections.parentQuestions.questions.modelAnswer.id

string

Example:

"57837640-c695-44a5-9667-9cfb8bafebf1"

data.sections.parentQuestions.questions.modelAnswer.answerText

string

Example:

""

data.sections.parentQuestions.questions.modelAnswer.stepMarking

object[]

Show child attributes

data.sections.parentQuestions.questions.modelAnswer.stepMarking.marksplit

number

Example:

1

data.sections.parentQuestions.questions.modelAnswer.stepMarking.step_wise_answer

string

Example:

"(b) (i) amylase, (ii) pepsin, (iii) trypsin"

data.sections.parentQuestions.questions.modelAnswer.stepMarking.modelanswer_diagram_description

string

Example:

""

data.sections.parentQuestions.questions.answer

object[]

Show child attributes

data.sections.parentQuestions.questions.answer.id

string

Example:

"f819bfd2-8aaa-42df-bd18-23cb989b2d16"

data.sections.parentQuestions.questions.answer.answerText

string

Example:

"(b) (i) amylase , (ii) pepsin, (iii) Trypsin"

data.sections.parentQuestions.questions.answer.marks

number<float>

Example:

1

data.sections.parentQuestions.questions.answer.isApproved

boolean

Example:

false

data.sections.parentQuestions.questions.answer.diagramDescription

string

Example:

null

data.sections.parentQuestions.questions.answer.aiFeedbacks

object[]

Show child attributes

data.sections.parentQuestions.questions.answer.aiFeedbacks.feedback

string

Example:

"The student has provided the correct answer, demonstrating a clear understanding of the enzymes associated with the specified locations. Great job!"

data.sections.parentQuestions.questions.answer.aiFeedbacks.student_text

string

Example:

"(b) (i) amylase , (ii) pepsin, (iii) Trypsin"

data.sections.parentQuestions.questions.answer.aiFeedbacks.justification

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

data.sections.parentQuestions.questions.answer.aiFeedbacks.marks_deducted

string

Example:

"0"

data.sections.parentQuestions.questions.answer.aiFeedbacks.room_for_improvement

string

Example:

"None, as the answer is correct and complete."

data.sections.parentQuestions.questions.answer.teacherFeedback

string

Example:

"The student has provided the correct answer, demonstrating a clear understanding of the enzymes associated with the specified locations. Great job!"

GET - Feedback The API retrieves all feedback and queries against the answer for the particular answer sheet ID. This includes: - Feedback from evaluators. - Queries raised by students. - Responses to the queries. **Scenario:** 1. **AI-Generated Feedback on Student's Answer Sheet:** - After the student’s answer sheet is submitted and reviewed, the teacher or administrator retrieves AI-generated feedback based on the student’s responses, model answers, and step-wise marking criteria. - **The API provides:** - **AI-Generated Feedback:** Detailed feedback on the student's answers, focusing on areas of improvement, correctness, and alignment with model answers. - **Query Handling:** If the student raised any queries, the API will provide AI-generated responses or clarifications. - **Outcome:** - The teacher can review the AI feedback to assess the student’s understanding, identify common issues, and offer additional clarification or support as needed.

⌘I

Retrieve final scores for an answer sheet

curl --request GET \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/get-final-result/ \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "publishedDate": "2024-12-26 09:58:30",
  "data": {
    "id": "4340132f-50fa-4877-9ffa-e9b7ee59d51f",
    "examName": "CBSE 10 – Mock Test",
    "subjectName": "Science",
    "totalMarks": 80,
    "obtainedMarks": 45,
    "questionMarkSumMismatch": false,
    "modelAnswerMarkSumMismatch": false,
    "overallDuration": "180",
    "overallInstruction": "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": [
      {
        "id": "ef66afc6-d923-43c6-b2d2-e29814306214",
        "sectionName": "SECTION A",
        "duration": null,
        "instruction": null,
        "totalMarks": 20,
        "obtainedMarks": 13,
        "parentQuestions": [
          {
            "id": "fcb22595-c36a-4ddf-b9d3-00ba6d2ea466",
            "text": "Identify the option that indicates the correct enzyme that is secreted in location i, ii and iii.",
            "marks": 1,
            "questionNumber": "Q1",
            "diagramDescription": null,
            "questionType": "MCQ",
            "questions": [
              {
                "id": "226986d3-95e4-4ed7-aaa4-3e7054f9bc5b",
                "text": "(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": 1,
                "isApproved": false,
                "questionNumber": "",
                "supportingText": "MCQ",
                "modelAnswer": {
                  "id": "57837640-c695-44a5-9667-9cfb8bafebf1",
                  "answerText": "",
                  "stepMarking": [
                    {
                      "marksplit": 1,
                      "step_wise_answer": "(b) (i) amylase, (ii) pepsin, (iii) trypsin",
                      "modelanswer_diagram_description": ""
                    }
                  ]
                },
                "answer": [
                  {
                    "id": "f819bfd2-8aaa-42df-bd18-23cb989b2d16",
                    "answerText": "(b) (i) amylase , (ii) pepsin, (iii) Trypsin",
                    "marks": 1,
                    "isApproved": false,
                    "diagramDescription": null,
                    "aiFeedbacks": [
                      {
                        "feedback": "The student has provided the correct answer, demonstrating a clear understanding of the enzymes associated with the specified locations. Great job!",
                        "student_text": "(b) (i) amylase , (ii) pepsin, (iii) Trypsin",
                        "justification": "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": "0",
                        "room_for_improvement": "None, as the answer is correct and complete."
                      }
                    ],
                    "teacherFeedback": "The student has provided the correct answer, demonstrating a clear understanding of the enzymes associated with the specified locations. Great job!"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Final Result

Authorizations

Path Parameters

Response