API Online

Elite High School API

Parents App backend services — interactive documentation & testing console

2026-03-24 11:33:04 UTC
PHP 7.4.33
Database Connected
Version 1.0.0
Total Endpoints 20 GET & POST
API Status Healthy Auto-detected
Database Connected MySQL / MariaDB
Auth JWT Bearer token

Authentication

4
POST /login.php Authenticate student & return profile Public

Parameters — JSON Body

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number
surnamestringrequiredStudent surname for verification

Example Request

curl -X POST /login.php \ -H "Content-Type: application/json" \ -d '{"studentID": "S001", "surname": "Doe"}'

Try It

POST /request_otp.php Send OTP to phone number Public

Parameters — JSON Body

NameTypeRequiredDescription
phonestringrequiredParent phone number (e.g. 0770123456)

Example Request

curl -X POST /request_otp.php \ -H "Content-Type: application/json" \ -d '{"phone": "0770123456"}'

Try It

POST /verify_otp.php Verify OTP & authenticate parent Public

Parameters — JSON Body

NameTypeRequiredDescription
phonestringrequiredPhone number used in OTP request
otpstringrequired6-digit OTP code received via SMS

Example Request

curl -X POST /verify_otp.php \ -H "Content-Type: application/json" \ -d '{"phone": "0770123456", "otp": "123456"}'

Try It

GET /search_student.php Search student by name Auth

Parameters — Query String

NameTypeRequiredDescription
searchstringrequiredStudent name search term

Example Request

curl /search_student.php?search=John \ -H "Authorization: Bearer <token>"

Try It

Student Data

6
GET /get_dashboard.php Student dashboard data Auth

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number

Example Request

curl /get_dashboard.php?studentID=S001 \ -H "Authorization: Bearer <token>"

Try It

GET /get_admission_status.php Check admission & enrollment status Auth

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number

Example Request

curl /get_admission_status.php?studentID=S001 \ -H "Authorization: Bearer <token>"

Try It

GET /get_student_reports.php Fetch academic reports Auth

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number

Example Request

curl /get_student_reports.php?studentID=S001 \ -H "Authorization: Bearer <token>"

Try It

GET /get_student_statement.php Financial statement & balance Auth

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number

Example Request

curl /get_student_statement.php?studentID=S001 \ -H "Authorization: Bearer <token>"

Try It

GET /get_report_html.php Render report as HTML Public

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number
termIDstringrequiredAcademic term identifier
yearIDstringrequiredAcademic year identifier

Example Request

curl /get_report_html.php?studentID=S001&termID=1&yearID=2025

Try It

GET /student_term_history.php Complete term history across years Public

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number

Example Request

curl /student_term_history.php?studentID=S001

Try It

Financial

1
GET /get_receipt_html.php Render payment receipt as HTML Public

Parameters — Query String

NameTypeRequiredDescription
studentIDstringrequiredStudent registration number
idstringrequiredPayment/receipt ID

Example Request

curl /get_receipt_html.php?studentID=S001&id=42

Try It

Notifications

3
GET /get_notifications.php Retrieve paginated notifications Auth

Parameters — Query String

NameTypeRequiredDescription
user_typestringrequired"student" or "parent"
user_idstringrequiredUser identifier
limitintoptionalResults per page (default: 20)
offsetintoptionalPagination offset

Example Request

curl /get_notifications.php?user_type=parent&user_id=P001&limit=10 \ -H "Authorization: Bearer <token>"

Try It

POST /mark_notification_read.php Mark notification(s) as read Auth

Parameters — JSON Body

NameTypeRequiredDescription
user_typestringrequired"student" or "parent"
user_idstringrequiredUser identifier
notification_idintoptionalSpecific notification ID
mark_allbooloptionalSet true to mark all as read

Example Request

curl -X POST /mark_notification_read.php \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"user_type":"parent","user_id":"P001","mark_all":true}'

Try It

POST /register_push_token.php Register device push token Auth

Parameters — JSON Body

NameTypeRequiredDescription
user_typestringrequired"student" or "parent"
user_idstringrequiredUser identifier
push_tokenstringrequiredExpo push token
platformstringrequired"android" or "ios"

Example Request

curl -X POST /register_push_token.php \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"user_type":"parent","user_id":"P001","push_token":"ExponentPushToken[xxx]","platform":"android"}'

Try It

School Content

3
GET /get_gallery.php Fetch school gallery images Public

Parameters — Query String

NameTypeRequiredDescription
limitintoptionalResults per page
offsetintoptionalPagination offset
categorystringoptionalFilter by category

Example Request

curl /get_gallery.php?limit=10&offset=0

Try It

GET /get_school_events.php Retrieve school events Public

Parameters — Query String

NameTypeRequiredDescription
limitintoptionalResults per page
offsetintoptionalPagination offset

Example Request

curl /get_school_events.php?limit=5

Try It

GET /get_school_news.php Fetch school news & announcements Public

Parameters — Query String

NameTypeRequiredDescription
limitintoptionalResults per page
offsetintoptionalPagination offset
locationstringoptionalFilter by location

Example Request

curl /get_school_news.php?limit=10

Try It

System

3
GET /api_status.php Health check & API status Public

Parameters

No parameters required.

Example Request

curl /api_status.php

Try It

GET /check_reportbatch.php View report batches & config Public

Parameters

No parameters required.

Example Request

curl /check_reportbatch.php

Try It

POST /unregister_push_token.php Remove device push token Public

Parameters — JSON Body

NameTypeRequiredDescription
push_tokenstringrequiredPush token to remove
user_typestringoptional"student" or "parent"
user_idstringoptionalUser identifier

Example Request

curl -X POST /unregister_push_token.php \ -H "Content-Type: application/json" \ -d '{"push_token":"ExponentPushToken[xxx]"}'

Try It