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:
- Call
GET /action-plan/v1/k12/student/{answer_sheet_id}with a validanswer_sheet_id(UUID) as a path parameter. - The API validates the UUID format and ensures the answer sheet exists.
- If a corresponding action plan exists, the system returns detailed information including student details, creation timestamp, and the action plan data.
- 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_idof 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.
GET
Retrieve Student Action Plan
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the student's answer sheet.
Response
Successful response containing the full student action plan.
Previous
POST - Teacher Action Plan This API allows authenticated clients to initiate a teacher-specific action plan for a given exam.
**How to Use:**
1. Call `POST /action-plan/v1/k12/teacher` with a JSON body containing a valid `exam_id` (UUID).
2. If validation succeeds, the system prepares and stores the teacher action plan data.
3. 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.
Next
Retrieve Student Action Plan