Get extracted exam questions

GET

evaluation-platform

exam

{examId}

questions

Get extracted exam questions

curl --request GET \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/questions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/questions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/questions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "examName": "Pre Board 1 - Science",
  "subjectName": "Science",
  "totalMarks": 80,
  "obtainedMarks": 0,
  "overallDuration": "180",
  "overallInstruction": "All questions are compulsory. Section A has 20 questions of 1 mark each.",
  "sections": [
    {
      "id": "ef66afc6-d923-43c6-b2d2-e29814306214",
      "sectionName": "SECTION A",
      "duration": null,
      "instruction": null,
      "totalQuestion": 20,
      "maxQuestionAttempt": 20,
      "totalMarks": 20,
      "obtainedMarks": null,
      "parentQuestions": [
        {
          "id": "fcb22595-c36a-4ddf-b9d3-00ba6d2ea466",
          "text": "Identify the option that gives the correct enzyme secreted at locations (i), (ii) and (iii).",
          "questionNumber": "Q1",
          "questionType": "MCQ",
          "isQuestionMarkMismatch": false,
          "totalQuestion": 1,
          "maxQuestionAttempt": 1,
          "marks": 1,
          "obtainedMarks": null,
          "questions": [
            {
              "id": "226986d3-95e4-4ed7-aaa4-3e7054f9bc5b",
              "text": "(a) (i) lipase (ii) trypsin (iii) pepsin\n(b) (i) amylase (ii) pepsin (iii) trypsin",
              "marks": 1,
              "isApproved": false,
              "questionNumber": "",
              "isModelAnswerMarkMismatch": false,
              "diagramDescription": null,
              "supportingText": "MCQ"
            }
          ]
        }
      ]
    }
  ]
}

Step 2 of 8 in Evaluate an exam. This is also how you wait for question extraction to finish.

Reading the response

Response	Meaning	What to do
`200`	The questions are ready	Show them for review
`400` `Exam is not processed yet`	Still extracting	Check again in 5 seconds
`400` `Exam processing failed, please try again!`	Extraction failed	Send `{"isFinal": true}` again on the exam
`404` `Exam not found`	Unknown exam ID	Check the ID

Questions sit three levels deep: sections, then parentQuestions, then questions. A student answers the innermost level.

maxQuestionAttempt says how many of the items below count toward the score. It equals the number of items unless the paper offers a choice.
isQuestionMarkMismatch and isModelAnswerMarkMismatch flag totals that do not add up. Fix them with Edit exam questions, answers, or marks before you evaluate any answer sheet.
obtainedMarks is 0 or null here. Marks only appear in the score responses.

Instead of polling, register a webhook for exam_evaluation_question_paper_extraction. See Async jobs and webhooks.

Next step

Create an exam model answer sheet

Start the answer key for this exam.

Authorizations

Authorization

string

header

required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Path Parameters

examId

string<uuid>

required

The exam id returned by Create an exam.

Example:

"d19e6868-98dd-4274-a2a5-4a616dd93ea7"

Response

The extracted question paper.

The extracted question paper: sections, question groups, and questions.

string<uuid>

The exam ID.

examName

string | null

subjectName

string | null

Subject name read from the paper, which can differ from the subject you sent.

totalMarks

integer | null

Total marks for the paper.

obtainedMarks

number<float>

Always 0 here. Marks appear only in the score responses.

overallDuration

string | null

overallInstruction

string | null

sections

object[]

Show child attributes

Get extracted exam questions

curl --request GET \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/questions/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/questions/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/questions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "examName": "Pre Board 1 - Science",
  "subjectName": "Science",
  "totalMarks": 80,
  "obtainedMarks": 0,
  "overallDuration": "180",
  "overallInstruction": "All questions are compulsory. Section A has 20 questions of 1 mark each.",
  "sections": [
    {
      "id": "ef66afc6-d923-43c6-b2d2-e29814306214",
      "sectionName": "SECTION A",
      "duration": null,
      "instruction": null,
      "totalQuestion": 20,
      "maxQuestionAttempt": 20,
      "totalMarks": 20,
      "obtainedMarks": null,
      "parentQuestions": [
        {
          "id": "fcb22595-c36a-4ddf-b9d3-00ba6d2ea466",
          "text": "Identify the option that gives the correct enzyme secreted at locations (i), (ii) and (iii).",
          "questionNumber": "Q1",
          "questionType": "MCQ",
          "isQuestionMarkMismatch": false,
          "totalQuestion": 1,
          "maxQuestionAttempt": 1,
          "marks": 1,
          "obtainedMarks": null,
          "questions": [
            {
              "id": "226986d3-95e4-4ed7-aaa4-3e7054f9bc5b",
              "text": "(a) (i) lipase (ii) trypsin (iii) pepsin\n(b) (i) amylase (ii) pepsin (iii) trypsin",
              "marks": 1,
              "isApproved": false,
              "questionNumber": "",
              "isModelAnswerMarkMismatch": false,
              "diagramDescription": null,
              "supportingText": "MCQ"
            }
          ]
        }
      ]
    }
  ]
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get extracted exam questions

Reading the response

Next step

Create an exam model answer sheet

Authorizations

Path Parameters

Response

​Reading the response

​Next step

Create an exam model answer sheet

Authorizations

Path Parameters

Response

Reading the response

Next step