> ## 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 - Extracted Model Answer
> The GET Model Answer Sheet Answers API allows clients to retrieve the detailed structure of the answers provided in the model answer sheet for a specific exam. This includes:
- Exam-level metadata such as total marks, duration, and instructions.
- Sections of the exam with parent and sub-questions.
- Model answers and their step-wise marking schemes.
**Scenarios:**
1. **Reviewing AI-Extracted Model Answers and Mapping:**
- Teachers use this API to validate AI-extracted model answers and their mapping to the corresponding exam questions.
- **Outcome:**
- The API provides exam metadata (e.g., total marks, duration), section-wise breakdowns, and model answers with marking schemes.
- Teachers ensure the structure is accurate and ready for evaluation.
2. **Verifying Step-Wise Marking for Evaluation:**
- Content moderators review step-wise marking schemes to confirm alignment with the provided answers.
- **Outcome:**
- The API delivers detailed model answers and marks allocated for individual steps in multi-part answers.
- Moderators ensure fair and accurate marking schemes, facilitating consistent evaluation by graders.
Want to receive automatic notifications when model answer sheets are processed? Set up webhooks to get real-time updates on model answer extraction. Check out the [Webhooks](/api-reference/endpoint/webhook/v1-get-webhook-template).
## OpenAPI
````yaml GET /evaluation-platform/v1/exam/{examId}/model-answer/{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/{examId}/model-answer/{id}/:
get:
summary: Get Extracted model answer details for an exam
operationId: get_model_answer
parameters:
- name: examId
in: path
required: true
schema:
type: string
example: 4340132f-50fa-4877-9ffa-e9b7ee59d51f
- in: path
name: id
required: true
schema:
type: string
example: 287117d6-0135-4329-b5a7-d46e42948a14
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier of the exam
example: 3fb48c7c-4437-4673-9cc2-218fcdb2f8c7
examName:
type: string
description: Exam Name
example: CBSE 10 – Mock Test
subjectName:
type: string
description: Subject Name
example: Science
totalMarks:
type: number
description: Total marks of 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: Duration of the exam
example: '180'
overallInstruction:
type: string
description: Instruction given 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 of 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: Instruction of the section
example: null
totalMarks:
type: number
description: Total marks of 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: Parent Questions in the section
items:
type: object
properties:
id:
type: string
description: Unique identifier of 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 of the parent question
example: 1
questionNumber:
type: string
description: Number of the question
example: Q1
questionType:
type: string
description: Type of the question
example: null
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: ''
diagramDescription:
type: string
example: null
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: ''
example:
id: 3fb48c7c-4437-4673-9cc2-218fcdb2f8c7
examName: CBSE 10 – Mock Test
subjectName: Science
totalMarks: 80
obtainedMarks: 0
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: 0
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
questionType: null
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: ''
diagramDescription: null
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: null
'400':
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: Model Answer is not processed 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 - 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: Model Answer not found
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````