GET - Extracted Model Answer

This API allows authenticated users to retrieve the model answer details of a specific assignment. The model answer may include associated documents, rubric information, and a hierarchical question structure with individual model answers per question.

Key Parameters:

assignmentId (path param, required): The unique ID of the assignment for which the model answer is requested.

Response Includes:

assignmentName: Title of the assignment.
courseId, grade: Educational context of the assignment.
parentQuestions[]: A list of question groups, each containing sub-questions.
For each question:
text, questionNumber, marks
modelAnswer: ID, linked rubric, step marking (if any), etc.

GET

assignment-evaluation

assignment

{id}

model-answer

{modelAnswerId}

Get Assignment Model Answer

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/model-answer/{modelAnswerId}/

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "test 2",
  "instruction": null,
  "marks": 0,
  "grade": null,
  "courseId": "300",
  "parentQuestions": [
    {
      "id": "b3098d35-50b4-4417-954f-0b9df6553bd4",
      "questionNumber": "Q1",
      "text": "Add olfactory imagery to the following:",
      "marks": 0,
      "questions": [
        {
          "id": "246b66a3-42b3-4f25-bb52-fe03475ef0c9",
          "questionNumber": "1",
          "text": "A flower shop",
          "marks": 0,
          "diagramDescription": "No diagram or image provided.",
          "modelAnswer": {
            "id": "69c0c508-ac57-4c43-a795-5ce0799a1240",
            "stepMarking": [],
            "rubric": "2b973c83-2830-4712-87b7-64a8c0a99035"
          }
        }
      ]
    }
  ]
}

Path Parameters

string

required

Unique identifier of the assignment

modelAnswerId

string

required

Unique identifier of the model answer

Response

Model answer sheet details retrieved successfully.

Assignment model answer sheet response

string<uuid>

Unique identifier of the assignment model answer sheet

Example:

"2600413f-7c6e-46ef-8ea9-3e7b5834879f"

assignmentName

string

Name of the assignment

Example:

"test 2"

instruction

string | null

Instruction text for the assignment (if any)

Example:

null

marks

number<float>

Total marks of the assignment

Example:

0

grade

string | null

Grade awarded for the assignment

Example:

null

courseId

string

Associated course identifier

Example:

"300"

parentQuestions

object[]

List of grouped questions with their children

Show child attributes

POST - Student Assignment Sheet The API allows clients to create a new assignment sheet for a specific student in an assignment. It associates the student's ID with an assignment sheet and returns the unique ID for the assignment sheet. The assignment sheet can later be updated with documents (e.g., scanned PDFs or images). **Scenarios:** 1. **Creating a New assignment Sheet for a Student:** - A teacher provides the student's ID to create a new assignment sheet. - **Outcome:** - The API generates a unique assignment sheet ID linked to the student. - This ID is used for future reference and document uploads. 2. **Associating Documents with the Created assignment Sheet:** - After scanning the student’s handwritten assignment sheet, the teacher uploads a PDF or JPEG images using the unique assignment sheet ID. - **Outcome:** - The scanned document is associated with the student’s assignment sheet, enabling it to be evaluated or graded in subsequent steps.

Get Assignment Model Answer

curl --request GET \
  --url https://api-staging.crazygoldfish.com/assignment-evaluation/v1/assignment/{id}/model-answer/{modelAnswerId}/

{
  "id": "2600413f-7c6e-46ef-8ea9-3e7b5834879f",
  "assignmentName": "test 2",
  "instruction": null,
  "marks": 0,
  "grade": null,
  "courseId": "300",
  "parentQuestions": [
    {
      "id": "b3098d35-50b4-4417-954f-0b9df6553bd4",
      "questionNumber": "Q1",
      "text": "Add olfactory imagery to the following:",
      "marks": 0,
      "questions": [
        {
          "id": "246b66a3-42b3-4f25-bb52-fe03475ef0c9",
          "questionNumber": "1",
          "text": "A flower shop",
          "marks": 0,
          "diagramDescription": "No diagram or image provided.",
          "modelAnswer": {
            "id": "69c0c508-ac57-4c43-a795-5ce0799a1240",
            "stepMarking": [],
            "rubric": "2b973c83-2830-4712-87b7-64a8c0a99035"
          }
        }
      ]
    }
  ]
}

Documentation Index

Path Parameters

Response