Parents App backend services — interactive documentation & testing console
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
| surname | string | required | Student surname for verification |
curl -X POST /login.php \
-H "Content-Type: application/json" \
-d '{"studentID": "S001", "surname": "Doe"}'
| Name | Type | Required | Description |
|---|---|---|---|
| phone | string | required | Parent phone number (e.g. 0770123456) |
curl -X POST /request_otp.php \
-H "Content-Type: application/json" \
-d '{"phone": "0770123456"}'
| Name | Type | Required | Description |
|---|---|---|---|
| phone | string | required | Phone number used in OTP request |
| otp | string | required | 6-digit OTP code received via SMS |
curl -X POST /verify_otp.php \
-H "Content-Type: application/json" \
-d '{"phone": "0770123456", "otp": "123456"}'
| Name | Type | Required | Description |
|---|---|---|---|
| search | string | required | Student name search term |
curl /search_student.php?search=John \
-H "Authorization: Bearer <token>"
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
curl /get_dashboard.php?studentID=S001 \
-H "Authorization: Bearer <token>"
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
curl /get_admission_status.php?studentID=S001 \
-H "Authorization: Bearer <token>"
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
curl /get_student_reports.php?studentID=S001 \
-H "Authorization: Bearer <token>"
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
curl /get_student_statement.php?studentID=S001 \
-H "Authorization: Bearer <token>"
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
| termID | string | required | Academic term identifier |
| yearID | string | required | Academic year identifier |
curl /get_report_html.php?studentID=S001&termID=1&yearID=2025
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
curl /student_term_history.php?studentID=S001
| Name | Type | Required | Description |
|---|---|---|---|
| studentID | string | required | Student registration number |
| id | string | required | Payment/receipt ID |
curl /get_receipt_html.php?studentID=S001&id=42
| Name | Type | Required | Description |
|---|---|---|---|
| user_type | string | required | "student" or "parent" |
| user_id | string | required | User identifier |
| limit | int | optional | Results per page (default: 20) |
| offset | int | optional | Pagination offset |
curl /get_notifications.php?user_type=parent&user_id=P001&limit=10 \
-H "Authorization: Bearer <token>"
| Name | Type | Required | Description |
|---|---|---|---|
| user_type | string | required | "student" or "parent" |
| user_id | string | required | User identifier |
| notification_id | int | optional | Specific notification ID |
| mark_all | bool | optional | Set true to mark all as read |
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}'
| Name | Type | Required | Description |
|---|---|---|---|
| user_type | string | required | "student" or "parent" |
| user_id | string | required | User identifier |
| push_token | string | required | Expo push token |
| platform | string | required | "android" or "ios" |
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"}'
| Name | Type | Required | Description |
|---|---|---|---|
| limit | int | optional | Results per page |
| offset | int | optional | Pagination offset |
| category | string | optional | Filter by category |
curl /get_gallery.php?limit=10&offset=0
| Name | Type | Required | Description |
|---|---|---|---|
| limit | int | optional | Results per page |
| offset | int | optional | Pagination offset |
curl /get_school_events.php?limit=5
| Name | Type | Required | Description |
|---|---|---|---|
| limit | int | optional | Results per page |
| offset | int | optional | Pagination offset |
| location | string | optional | Filter by location |
curl /get_school_news.php?limit=10
No parameters required.
curl /api_status.php
No parameters required.
curl /check_reportbatch.php
| Name | Type | Required | Description |
|---|---|---|---|
| push_token | string | required | Push token to remove |
| user_type | string | optional | "student" or "parent" |
| user_id | string | optional | User identifier |
curl -X POST /unregister_push_token.php \
-H "Content-Type: application/json" \
-d '{"push_token":"ExponentPushToken[xxx]"}'