Student Management

​

1. API Purpose

​

2. Endpoint Definition

​

3. Authentication Flow

• Guardians: Access is restricted to children linked to the parent’s phone_no in the database.
• Teachers: Access is restricted to students assigned to them via the staff_student junction table.
• Admins: Full access scoped by skole_id.

​

4. Request Structure

​

GET /teachers-app/students

​

GET /web-app/students

​

PUT /web-app/students/:id

{
  "student_full_name": "Aarav Sharma",
  "gender": "Male",
  "grade": "Grade 5-A",
  "date_of_birth": "2013-05-15",
  "blood_group": "B+",
  "phone_no": "9876543210"
}

​

POST /web-app/students/:id/archive

​

POST /web-app/students/:id/reset-password

{
  "password": "NewSecurePassword123"
}

​

5. Response Structure

​

Success: Child Profile Detail (200 OK)

{
  "success": true,
  "data": {
    "student": {
      "id": 45,
      "student_full_name": "Aarav Sharma",
      "roll_no": "20240045",
      "grade": "Grade 5-A"
    },
    "guardian": { "father_name": "Rajesh Kumar" }
  }
}

​

Success: Teacher Student List (200 OK)

{
  "success": true,
  "data": [
    {
      "id": 45,
      "student_full_name": "Aarav Sharma",
      "roll_no": "20240045"
    }
  ]
}

​

Success: Admin Student Registry (200 OK)

{
  "success": true,
  "data": {
    "students": [...],
    "pagination": { "total": 1200, "page": 1 }
  }
}

​

Success: Student Updated (200 OK)

{
  "success": true,
  "message": "Student record updated successfully"
}

​

Success: Record Archived (200 OK)

{
  "success": true,
  "message": "Student moved to archives"
}

​

Success: PIN Reset (200 OK)

{
  "success": true,
  "message": "Parent PIN has been reset"
}

​

6. Error Responses

​

7. Security Considerations

• PIN Security: Resetting a PIN requires Admin-level JWT.
• Isolation: Cross-tenant access is blocked via the global SkoleGuard.

​

8. Token Usage

GET /parent-app/student-detail?roll_no=A001
Authorization: Bearer <TOKEN>

​

9. Token Refresh

​

10. Logout / Session Invalidation

​

11. Usage Example (cURL)

curl -H "Authorization: Bearer <TOKEN>" \
"http://localhost:3000/web-app/students?grade=Grade%205"

​

12. Notes / Special Behaviors

• Lifecycle: Students can move from registered to active, inactive, and eventually archived.
• Roll Numbers: Roll numbers must be unique within a school (skole_id).