✨ Result
Endpoint : /results (GET method expected)
Example API Response
js
[
{
"title_name": "SA1", // Title or name of the result (e.g., "SA1", "Annual Exam")
"year": "2024-2025", // Academic year for the result
"student_side_show": true, // Boolean indicating if the result should be visible to students
"file": "file_url/studentUniqueID(gr_no).pdf" // file url of the result PDF. The filename should follow the convention: studentUniqueID(gr_no).pdf
}
]Mandatory Parameters
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| year | format | Academic year for the result | 2024-2025 |
| title_name | text | Title or name of the result (e.g., "SA1", "Annual Exam") | SA1 |
Optional Parameters
The optional parameters in the HTTP API are tabulated below:
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| student_side_show | Boolean | Boolean indicating if the result should be visible to students | true |
| file | text | file url of the result PDF. The filename should follow the convention: studentUniqueID(gr_no).pdf | file_url/studentUniqueID(gr_no).pdf |
Notes:
- The
filefield specifies the expected naming convention for the PDF files. Ensure that the student's unique ID or GR number is used as indicated. - Confirm the exact format of
studentUniqueID(gr_no)(e.g., is it literally "studentUniqueID(gr_no)" or a placeholder likestudent_unique_id.pdf).
