Raise a query on exam feedback

POST

evaluation-platform

exam

{examId}

answer-sheet

{ansSheetId}

answer

{ansId}

feedback

Raise a query on exam feedback

curl --request POST \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/answer/{ansId}/feedback/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbackId": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
  "queryType": 2,
  "text": "I wrote trypsin for (iii) in the second line, please check again."
}
'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/answer/{ansId}/feedback/"

payload = {
    "feedbackId": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
    "queryType": 2,
    "text": "I wrote trypsin for (iii) in the second line, please check again."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    feedbackId: '3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462',
    queryType: 2,
    text: 'I wrote trypsin for (iii) in the second line, please check again.'
  })
};

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

{
  "data": {
    "id": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
    "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
    "studentId": "S-2043",
    "answerId": "f819bfd2-8aaa-42df-bd18-23cb989b2d16",
    "feedback": "The enzyme for location (iii) is trypsin, not pepsin.",
    "marks_deducted": "1",
    "justification": "Pepsin acts in the stomach, so it cannot be the enzyme at location (iii).",
    "room_for_improvement": "Revise which enzyme each digestive organ secretes.",
    "feedbackQuery": [
      {
        "id": "9c4e2a18-7d35-4b61-8e0f-2a6b5c3d9e71",
        "createdByRole": "Student",
        "queryType": 2,
        "status": 2,
        "text": "I wrote trypsin for (iii) in the second line, please check again.",
        "responses": []
      }
    ]
  }
}

Step 8 of 8 in Evaluate an exam. Use it after the provisional result is published.

Rules

feedbackId, queryType, and text are all required.
feedbackId comes from Get exam answer feedback and queries. It has to be an existing feedback record.
text is the student’s own words. It goes to the AI as the student’s comment.

`queryType`	Meaning
`1`	Classification
`2`	Re-evaluation Request
`3`	Other Concerns

Every query triggers an AI re-evaluation of that answer, whatever the queryType. If the AI agrees with the student, the answer’s marks change and the exam’s totals change with them. Only expose this to students once you are happy for that to happen.

What happens next

The query is recorded

Its status becomes 2 In Review at once, and the response returns the whole feedback record with the new query inside feedbackQuery.

The AI takes a second look

It sees the question, the model answer, the student’s answer, the marks, and the student’s comment.

The AI replies

Its justification is added to the query’s responses with createdByRole of AI, the marks are revised if it agrees, and the query’s status becomes 3 Resolved. Poll Get exam answer feedback and queries to pick this up.

Next step

Reply to an exam feedback query

Add a teacher’s answer to the thread.

Update an exam feedback query status

Mark the query as resolved.

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. Write it in lowercase: this path only matches lowercase hexadecimal characters and hyphens.

Example:

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

ansSheetId

string<uuid>

required

The answer sheet id returned by Create an exam answer sheet. Write it in lowercase.

Example:

"8a2f4c1e-5b3d-4e6f-9a7b-0c1d2e3f4a5b"

ansId

string<uuid>

required

The answer id from answer[].id in Get exam scores for review. Write it in lowercase.

Example:

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

Body

application/json

feedbackId

string<uuid>

required

The feedback this query is about, from Get exam answer feedback and queries.

queryType

enum<integer>

required

1 Classification, 2 Re-evaluation Request, 3 Other Concerns.

Available options:

1,

2,

3

text

string

required

What the student wants to say. It is sent to the AI as the student's comment.

Response

The query was recorded and sent for re-evaluation. The response is the whole feedback record, with the new query in feedbackQuery.

data

object

One reason the AI deducted marks from an answer, with any queries raised against it.

Show child attributes

Example:

{
  "id": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
  "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
  "studentId": "S-2043",
  "answerId": "f819bfd2-8aaa-42df-bd18-23cb989b2d16",
  "feedback": "The enzyme for location (iii) is trypsin, not pepsin.",
  "marks_deducted": "1",
  "justification": "Pepsin acts in the stomach, so it cannot be the enzyme at location (iii).",
  "room_for_improvement": "Revise which enzyme each digestive organ secretes.",
  "feedbackQuery": [
    {
      "id": "9c4e2a18-7d35-4b61-8e0f-2a6b5c3d9e71",
      "createdByRole": "Student",
      "queryType": 2,
      "status": 2,
      "text": "I wrote trypsin for (iii) in the second line, please check again.",
      "responses": [
        {
          "id": "4f8a1d27-3c65-4e92-b8a0-1d7e5c4b9f36",
          "createdByRole": "AI",
          "text": "The second line repeats pepsin, so the deduction stands."
        }
      ]
    }
  ]
}

Raise a query on exam feedback

curl --request POST \
  --url https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/answer/{ansId}/feedback/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbackId": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
  "queryType": 2,
  "text": "I wrote trypsin for (iii) in the second line, please check again."
}
'

import requests

url = "https://api.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/answer/{ansId}/feedback/"

payload = {
    "feedbackId": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
    "queryType": 2,
    "text": "I wrote trypsin for (iii) in the second line, please check again."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    feedbackId: '3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462',
    queryType: 2,
    text: 'I wrote trypsin for (iii) in the second line, please check again.'
  })
};

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

{
  "data": {
    "id": "3d1c8b57-6e94-4a2f-b0d3-7c5e9a18f462",
    "examId": "d19e6868-98dd-4274-a2a5-4a616dd93ea7",
    "studentId": "S-2043",
    "answerId": "f819bfd2-8aaa-42df-bd18-23cb989b2d16",
    "feedback": "The enzyme for location (iii) is trypsin, not pepsin.",
    "marks_deducted": "1",
    "justification": "Pepsin acts in the stomach, so it cannot be the enzyme at location (iii).",
    "room_for_improvement": "Revise which enzyme each digestive organ secretes.",
    "feedbackQuery": [
      {
        "id": "9c4e2a18-7d35-4b61-8e0f-2a6b5c3d9e71",
        "createdByRole": "Student",
        "queryType": 2,
        "status": 2,
        "text": "I wrote trypsin for (iii) in the second line, please check again.",
        "responses": []
      }
    ]
  }
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Raise a query on exam feedback

Rules

What happens next

Next step

Reply to an exam feedback query

Update an exam feedback query status

Authorizations

Path Parameters

Body

Response

​Rules

​What happens next

​Next step

Reply to an exam feedback query

Update an exam feedback query status

Authorizations

Path Parameters

Body

Response

Rules

What happens next

Next step