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/studentwith a JSON body containing a validans_sheet_id(UUID). - If validation succeeds, the system prepares and stores the student action plan.
- A
201 Createdresponse is returned with a confirmation message and the relatedans_sheet_id.
Validation Details:
- The
ans_sheet_idmust 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 Requestresponse 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
Create Student Action Plan
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Unique identifier of the student's answer sheet.