Documentation

Introduction

Welcome to the EDUPlus Portal documentation. This comprehensive guide will help you understand and use all features of the platform effectively.

EDUPlus Portal is a unified web application that combines parent and student functionality, providing seamless access to exam results, progress reports, and school information through modern APIs.

Getting Started

System Requirements

• Modern web browser (Chrome, Firefox, Safari, Edge)
• Stable internet connection
• JavaScript enabled
• Cookies enabled for authentication

First Time Login

1. Navigate to the login page
2. Select your user type (Parent or Student)
3. Enter your credentials provided by your school
4. Click "Sign In"
5. Change your password on first login (recommended)

Parent Guide

Dashboard Overview

The parent dashboard provides a comprehensive view of all your children's academic information in one place.

Managing Multiple Children

If you have multiple children enrolled, you can easily switch between them using the learner selector at the top of the dashboard.

Viewing Exam Results

1. Select the child from the learner selector
2. Click on "Exam Results" from the menu
3. Choose the academic year and period
4. View detailed results with subject breakdowns
5. Download PDF reports if needed

Accessing Progress Reports

1. Navigate to "Progress Report" section
2. Select the academic year and term
3. Review overall performance, attendance, and teacher comments
4. Download comprehensive report as PDF

Student Guide

Student Dashboard

Students have access to their own personalized dashboard with academic information, timetables, and resources.

Checking Your Results

Students can view their exam results as soon as they are published by the school. Results include subject marks, grades, and teacher feedback.

Viewing Your Timetable

Access your class timetable to see your daily schedule, subjects, and classroom assignments.

Features

API Reference

EDUPlus Portal uses RESTful APIs from the _backend service. Below are the key endpoints used:

Authentication

POST http://localhost:5181/v0.1/parent/login
Content-Type: application/json

{
  "email": "parent@example.com",
  "password": "password123"
}

POST http://localhost:5181/v0.1/student/login
Content-Type: application/json

{
  "student_id": "EHS2301000339",
  "password": "password123"
}

Data Retrieval

GET http://localhost:5181/v0.1/parent/{parent_id}/portal/latest_children

GET http://localhost:5181/v0.1/instance/{instance_code}/student/{id}/exam_results?yr=2025&period_number=1

POST http://localhost:5181/v0.1/instance/{instance_code}/student/{id}/eot_report_url
Content-Type: application/json

{
  "yr": 2025,
  "period_type": "term",
  "period_number": 1,
  "mnth": 3,
  "exam_type": 1,
  "report_type": "short"
}

Troubleshooting