Skip to content

✨ 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

NameParameterDescriptionExpected Values
yearformatAcademic year for the result2024-2025
title_nametextTitle or name of the result (e.g., "SA1", "Annual Exam")SA1

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

NameParameterDescriptionExpected Values
student_side_showBooleanBoolean indicating if the result should be visible to studentstrue
filetextfile url of the result PDF. The filename should follow the convention: studentUniqueID(gr_no).pdffile_url/studentUniqueID(gr_no).pdf

Notes:

  • The file field 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 like student_unique_id.pdf).

Thank You!