POST - Student Action Plan

This API allows authenticated clients to initiate a student-specific action plan for a given answer sheet.

How to Use:

Call POST /action-plan/v1/k12/student with a JSON body containing a valid ans_sheet_id (UUID).
If validation succeeds, the system prepares and stores the student action plan.
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.

POST

action-plan

k12

student

Create Student Action Plan

curl --request POST \
  --url https://api-staging.crazygoldfish.com/action-plan/v1/k12/student \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ans_sheet_id": "b5a8d8c1-4a34-4e3c-97ab-52972d0bfcf9"
}
'

{
  "status_code": 201,
  "response_id": "b5a8d8c1-4a34-4e3c-97ab-52972d0bfcf9",
  "message": "Student action plan initiated successfully."
}

Authorizations

Authorization

string

header

required

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

Body

application/json

ans_sheet_id

string<uuid>

required

Unique identifier of the student's answer sheet.

Response

Student action plan successfully initiated.

status_code

integer

required

Example:

201

response_id

string<uuid>

required

The answer sheet ID associated with the new student action plan.

message

string

required

Example:

"Student action plan initiated successfully."

GET - Student Action Plan This API allows authenticated clients to retrieve the student-specific action plan associated with a given answer sheet. **How to Use:** 1. Call `GET /action-plan/v1/k12/student/{answer_sheet_id}` with a valid `answer_sheet_id` (UUID) as a path parameter. 2. The API validates the UUID format and ensures the answer sheet exists. 3. If a corresponding action plan exists, the system returns detailed information including student details, creation timestamp, and the action plan data. 4. If the ID is invalid or the action plan is not found, a descriptive error is returned. **Example Scenario:** A teacher wants to view a personalized action plan for a student: - They send a GET request with the `answer_sheet_id` of the student's answer sheet. - The API validates the ID and checks for an associated action plan. - If found, the system returns the student's information and the generated action plan for further review.

Create Student Action Plan

curl --request POST \
  --url https://api-staging.crazygoldfish.com/action-plan/v1/k12/student \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ans_sheet_id": "b5a8d8c1-4a34-4e3c-97ab-52972d0bfcf9"
}
'

{
  "status_code": 201,
  "response_id": "b5a8d8c1-4a34-4e3c-97ab-52972d0bfcf9",
  "message": "Student action plan initiated successfully."
}