POST - Worksheet Feedback

This API allows authenticated users to create feedback entries for a worksheet.

How to Use:

Call POST /worksheet/v1/feedback/{work_sheet_id} with the feedback details including rating, comment, feedback type, and optional fields.
The API validates that the worksheet exists and creates a new feedback entry.

Request Body Parameters:

rating (optional): Integer between 1 and 5, representing the rating for the worksheet.
comment (required): Text feedback or comment about the worksheet.
feedback_type (required): Type of feedback ( May be one of them: general, content, quality, suggestion).
feedback_data (optional): Structured feedback data as a JSON object for additional context.
step_name (optional): Specific step name if the feedback is for a particular step in the worksheet.
component_name (optional): Specific component name if the feedback is for a particular component.

POST

worksheet

feedback

{work_sheet_id}

Create worksheet Feedback

curl --request POST \
  --url https://api-staging.crazygoldfish.com/worksheet/v1/feedback/{work_sheet_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rating": 4,
  "comment": "The worksheet is well-structured and covers all key concepts. However, I suggest adding more interactive activities.",
  "feedback_type": "suggestion",
  "feedback_data": {
    "strengths": [
      "Clear objectives",
      "Good pacing"
    ],
    "improvements": [
      "Add more examples",
      "Include assessment rubric"
    ]
  },
  "step_name": "Introduction",
  "component_name": "Learning Objectives"
}
'

{
  "detail": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "msg": "Feedback created successfully."
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

work_sheet_id

string<uuid>

required

Unique identifier of the worksheet

Body

application/json

comment

string

required

Text feedback/comment about the worksheet

Example:

"The worksheet is well-structured and covers all key concepts. However, I suggest adding more interactive activities."

feedback_type

enum<string>

required

Type of feedback. Must be one of: general (general feedback), content (content-specific feedback), quality (quality feedback), suggestion (suggestions for improvement)

Available options:

general,

content,

quality,

suggestion

Example:

"suggestion"

rating

integer

Rating from 1 to 5

Required range: 1 <= x <= 5

Example:

4

feedback_data

object

Structured feedback data as a JSON object for additional context

Example:

{
  "strengths": ["Clear objectives", "Good pacing"],
  "improvements": [
    "Add more examples",
    "Include assessment rubric"
  ]
}

step_name

string

Specific step name if feedback is for a particular step in the worksheet

Example:

"Introduction"

component_name

string

Specific component name if feedback is for a particular component

Example:

"Learning Objectives"

Response

Feedback created successfully.

detail

object[]

required

Show child attributes

POST - Student Action Plan This API allows authenticated clients to initiate a student-specific action plan for a given answer sheet. **How to Use:** 1. Call `POST /action-plan/v1/k12/student` with a JSON body containing a valid `ans_sheet_id` (UUID). 2. If validation succeeds, the system prepares and stores the student action plan. 3. A `201 Created` response is returned with a confirmation message and the related `ans_sheet_id`. **Validation Details:** - The `ans_sheet_id` must be a valid UUID and correspond to an existing answer sheet record. - If the answer sheet does not exist or validation fails, a `400 Bad Request` response is returned with detailed error information. - Any unexpected errors result in a `500 Internal Server Error`. **Example Scenario:** A teacher wants to create a personalized action plan for a specific student's answer sheet: - They send a POST request with the required `ans_sheet_id`. - The API validates the ID and associates it with the authenticated client's ID. - If valid, the system generates and stores the student action plan. - The teacher receives a success message confirming that the student action plan has been initiated.

Create worksheet Feedback

curl --request POST \
  --url https://api-staging.crazygoldfish.com/worksheet/v1/feedback/{work_sheet_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rating": 4,
  "comment": "The worksheet is well-structured and covers all key concepts. However, I suggest adding more interactive activities.",
  "feedback_type": "suggestion",
  "feedback_data": {
    "strengths": [
      "Clear objectives",
      "Good pacing"
    ],
    "improvements": [
      "Add more examples",
      "Include assessment rubric"
    ]
  },
  "step_name": "Introduction",
  "component_name": "Learning Objectives"
}
'

{
  "detail": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "msg": "Feedback created successfully."
    }
  ]
}

Documentation Index

Authorizations

Path Parameters

Body

Response