POST - Teacher Action Plan

This API allows authenticated clients to initiate a teacher-specific action plan for a given exam.

How to Use:

Call POST /action-plan/v1/k12/teacher with a JSON body containing a valid exam_id (UUID).
If validation succeeds, the system prepares and stores the teacher action plan data.
A 201 Created response is returned with a confirmation message and the related exam_id.

Validation Details:

The exam_id must be a valid UUID and correspond to an existing exam record.
If the exam does not exist or validation fails, a 400 Bad Request response is returned with error details.
Any unexpected errors result in a 500 Internal Server Error.

Example Scenario:

A school admin wants to create a teacher action plan for a specific exam:

They send a POST request with the required exam_id.
The API validates the exam and associates it with the authenticated client’s ID.
If valid, the system prepares and stores the plan.
The admin receives a success message confirming that the teacher action plan has been initiated.

POST

action-plan

k12

teacher

Create Teacher Action Plan

curl --request POST \
  --url https://api-staging.crazygoldfish.com/action-plan/v1/k12/teacher \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exam_id": "d7c8333e-9a2d-4c6d-8bb8-4a02ad6e43fd"
}
'

{
  "status_code": 201,
  "response_id": "d7c8333e-9a2d-4c6d-8bb8-4ass02ad6e43fd",
  "message": "Teacher 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

exam_id

string<uuid>

required

Unique identifier of the exam for which the teacher action plan will be created.

Response

Teacher action plan successfully initiated.

status_code

integer

required

Example:

201

response_id

string<uuid>

required

The exam ID that was used to create the teacher action plan.

message

string

required

Example:

"Teacher action plan initiated successfully."

GET - Teacher Action Plan This API allows authenticated clients to retrieve the teacher action plan associated with a specific exam. **How to Use:** 1. Call `GET /action-plan/v1/k12/teacher/{exam_id}` with a valid `exam_id` (UUID) as a path parameter. 2. The API validates the UUID format and checks if the exam exists. 3. If the exam and its teacher action plan exist, it returns details about the exam and the corresponding action plan. 4. If the exam or action plan is not found, an appropriate error is returned. **Example Scenario:** A school administrator wants to review the teacher action plan for a particular exam: - They send a GET request with the `exam_id` of the exam. - The API validates the ID and verifies that an action plan exists. - If valid, the system returns the exam details and the stored teacher action plan. - The admin can then review the plan for implementation or reporting.

Create Teacher Action Plan

curl --request POST \
  --url https://api-staging.crazygoldfish.com/action-plan/v1/k12/teacher \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exam_id": "d7c8333e-9a2d-4c6d-8bb8-4a02ad6e43fd"
}
'

{
  "status_code": 201,
  "response_id": "d7c8333e-9a2d-4c6d-8bb8-4ass02ad6e43fd",
  "message": "Teacher action plan initiated successfully."
}