POST - Raise Feedback

The API allows students to raise queries in the feedback for a particular answer sheet ID. The AI will respond to these queries first. This includes:

Feedback from the AI.
Queries raised by students.
AI responses to the queries.
Responses to the queries from teachers.

Scenario 1:

Raising Queries by Students and AI Response:
- After reviewing their exam, a student may raise a query about specific marks or feedback on a particular question (identified by the answer sheet’s UUID).
- The API provides:
  - AI-Generated Feedback: The AI analyzes the student’s response and provides feedback on it.
  - Student Query: The specific query the student raised about their performance or feedback on a question.
  - AI Response: The AI’s explanation or clarification on the marks awarded or the student’s question.
- Outcome:
  - The student receives an immediate AI-driven response, and the teacher can review this feedback and take necessary actions, like adjusting marks or offering more details.

Scenario 2:

Teacher Reviewing and Responding to Student Queries:
- After the AI has responded to a query, the teacher reviews the AI’s response and provides their own feedback.
- Outcome:
  - The teacher can approve, modify, or clarify the AI’s response, ensuring that the grading process remains transparent and accurate.

POST

evaluation-platform

exam

{examId}

answer-sheet

{ansSheetId}

answer

{ansId}

feedback

Submit Answer Sheet Feedback

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/answer/{ansId}/feedback/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbackId": "def80534-8f59-49ea-b43e-553075b1db91",
  "queryType": 1,
  "text": "why my marks has been deducted"
}
'

{
  "data": {
    "id": "def80534-8f59-49ea-b43e-553075b1db91",
    "examId": "edaf2e84-e911-4150-9628-6d182a05ed0d",
    "studentId": "10160091",
    "answerId": "11637fca-dc77-4b63-88c0-ec74126d951c",
    "feedback": "The student selected an incorrect option. It is important to carefully analyze the question and the options provided. Understanding the characteristics of a homologous series is crucial for answering such questions correctly.",
    "marks_deducted": "1 - incorrect option selected",
    "justification": "The student's answer (c) gradation in Physical Properties is incorrect as it does not address the question of what is not observed in a homologous series. The model answer correctly identifies (a) Change in chemical properties as the correct response.",
    "room_for_improvement": "To achieve full marks, the student should select the correct option (a) Change in chemical properties, which is the only option that is not observed in a homologous series.",
    "feedbackQuery": [
      {
        "id": "e2b75a94-bc8a-4a2b-a23f-32abc1198f37",
        "createdByRole": "Student",
        "queryType": 1,
        "status": 2,
        "text": "why my marks has been deducted",
        "responses": [
          "<unknown>"
        ]
      }
    ]
  }
}

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

ansId

string

required

Body

application/json

feedbackId

string

required

The unique identifier for the feedback entry.

Example:

"def80534-8f59-49ea-b43e-553075b1db91"

queryType

integer

required

The type of query being submitted or you can refer to the constant API docs

Example:

1

text

string

required

The text of the query submitted by the student.

Example:

"why my marks has been deducted"

Response

Success - Feedback details retrieved successfully.

data

object

Feedback details retrieved successfully.

Show child attributes

data.id

string

Feedback unique identifier against the answers.

Example:

"def80534-8f59-49ea-b43e-553075b1db91"

data.examId

string

Unique identifier of the exam.

Example:

"edaf2e84-e911-4150-9628-6d182a05ed0d"

data.studentId

string

Unique identifier of the student.

Example:

"10160091"

data.answerId

string

Unique identifier of the answer.

Example:

"11637fca-dc77-4b63-88c0-ec74126d951c"

data.feedback

string

Feedback provided for the answer.

Example:

"The student selected an incorrect option. It is important to carefully analyze the question and the options provided. Understanding the characteristics of a homologous series is crucial for answering such questions correctly."

data.marks_deducted

string

Marks deducted for the answer.

Example:

"1 - incorrect option selected"

data.justification

string

Justification for the feedback provided.

Example:

"The student's answer (c) gradation in Physical Properties is incorrect as it does not address the question of what is not observed in a homologous series. The model answer correctly identifies (a) Change in chemical properties as the correct response."

data.room_for_improvement

string

Room for improvement for the student.

Example:

"To achieve full marks, the student should select the correct option (a) Change in chemical properties, which is the only option that is not observed in a homologous series."

data.feedbackQuery

object[]

Feedback query raise by the student

Show child attributes

data.feedbackQuery.id

string

Feedback query unique identifier.

Example:

"e2b75a94-bc8a-4a2b-a23f-32abc1198f37"

data.feedbackQuery.createdByRole

string

Role of the user who created the feedback query.

Example:

"Student"

data.feedbackQuery.queryType

integer

Type of query raised by the student.

Example:

1

data.feedbackQuery.status

integer

Status of the feedback query.

Example:

2

data.feedbackQuery.text

string

Text of the feedback query.

Example:

"why my marks has been deducted"

data.feedbackQuery.responses

any[]

Responses to the feedback query.

PATCH - Raise Feedback This endpoint allows you to update the status of a query that has been raised against a specific feedback. You need to provide the exam ID, answer sheet ID, answer ID, feedback ID, and feedback query ID to identify the query. The status of the query can be updated to reflect its current state. **Scenario: Updating the Status of a Student's Query:** 1. **Updating Query Status:** - After reviewing a student’s query about feedback on their answer sheet, the teacher or administrator updates the status of the query (either resolved or pending). - **The API requires:** - **Identifiers such as:** exam ID, answer sheet ID, answer ID, feedback ID, and feedback query ID. - **Outcome:** - The status update clarifies whether the query is resolved or still pending, helping track the progress and resolution of each student’s query.

⌘I

Submit Answer Sheet Feedback

curl --request POST \
  --url https://api-staging.crazygoldfish.com/evaluation-platform/v1/exam/{examId}/answer-sheet/{ansSheetId}/answer/{ansId}/feedback/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedbackId": "def80534-8f59-49ea-b43e-553075b1db91",
  "queryType": 1,
  "text": "why my marks has been deducted"
}
'

{
  "data": {
    "id": "def80534-8f59-49ea-b43e-553075b1db91",
    "examId": "edaf2e84-e911-4150-9628-6d182a05ed0d",
    "studentId": "10160091",
    "answerId": "11637fca-dc77-4b63-88c0-ec74126d951c",
    "feedback": "The student selected an incorrect option. It is important to carefully analyze the question and the options provided. Understanding the characteristics of a homologous series is crucial for answering such questions correctly.",
    "marks_deducted": "1 - incorrect option selected",
    "justification": "The student's answer (c) gradation in Physical Properties is incorrect as it does not address the question of what is not observed in a homologous series. The model answer correctly identifies (a) Change in chemical properties as the correct response.",
    "room_for_improvement": "To achieve full marks, the student should select the correct option (a) Change in chemical properties, which is the only option that is not observed in a homologous series.",
    "feedbackQuery": [
      {
        "id": "e2b75a94-bc8a-4a2b-a23f-32abc1198f37",
        "createdByRole": "Student",
        "queryType": 1,
        "status": 2,
        "text": "why my marks has been deducted",
        "responses": [
          "<unknown>"
        ]
      }
    ]
  }
}

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

POST - Raise Feedback

Authorizations

Path Parameters

Body

Response