✨ Notice

Endpoint : /notices (GET method expected)

Example API Response

[
  {
    "year": "2024-2025",                // Academic year for the notice
    "notice_title": "Demo",              // Title of the notice
    "notice_type": "School",             // Type of notice: "School", "Class", or "Employee"
    "standard_division": [              // Applicable if noticeType is "Class". Array of standard-division combinations (e.g., "SR.KG-A").
      "SR.KG-A",
      "1-A"
    ],
    "student_gr_number": [               // Applicable if noticeType is "Class". Array of student usernames.
      "001",
      "002"
    ],
    "employee_id": [             // Applicable if noticeType is "Employee". Array of employee identifiers.
      "001",
      "002"
    ],
    "description": "Testing",           // Detailed description of the notice
    "upload_notice_image_name": [        // Array of file url for any attached images.
      "file_url/test.jpg",
      "file_url/hello.jpg"
    ],
    "tags": []                          // Optional array of tags associated with the notice
  }

]

Mandatory Parameters

Name	Parameter	Description	Expected Values
notice_title	Text	Title of the notice	Demo
year	format	Academic year for the album	2024-2025

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
notice_type	Text	Type of notice: "School", "Class", or "Employee"	School or Class or Employee
standard_division	Array	Applicable if noticeType is "Class". Array of standard-division combinations (e.g., "[SR.KG-A]").	[SR.KG-A,1-A]
student_gr_number	Array	Applicable if noticeType is "Class". Array of student usernames.	[001,002]
employee_id	Array	Applicable if noticeType is "Employee". Array of employee identifiers.	[001,002]
description	Text	Detailed description of the notice	Testing
upload_notice_image_name	Array	Array of file url for any attached images.	[file_url/test.jpg,file_url/hello.jpg]
tag	Array	Optional array of tags associated with the notice	[]

Notes:

• The fields standard_division and student_gr_number are relevant when noticeType is "Class".
• The employee_id field is relevant when noticeType is "Employee". Ensure the format of these identifiers is consistent with your employee database.
• Type of notice: "School", "Class", or "Employee"

Thank You!