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/teacherwith a JSON body containing a validexam_id(UUID). - If validation succeeds, the system prepares and stores the teacher action plan data.
- A
201 Createdresponse is returned with a confirmation message and the relatedexam_id.
Validation Details:
- The
exam_idmust be a valid UUID and correspond to an existing exam record. - If the exam does not exist or validation fails, a
400 Bad Requestresponse 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
Create Teacher Action Plan
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Unique identifier of the exam for which the teacher action plan will be created.