✨ Gallery
Endpoint : /gallery (GET method expected)
Example API Response
js
[
{
"name": "Demo", // Name of the album
"year": "2024-2025!", // Academic year for the album
"date": "2025-12-12", // Date of the album (YYYY-MM-DD format is preferred for consistency)
"album_type": "All", // Type of album: "All" for school-wide, "Division" for specific divisions
"select_division": [ // Applicable only if albumType is "Division". Array of division identifiers.
"JR.KG-A",
"1-A"
],
"description": "", // Optional description for the album
"upload_cover_image_name": "file_url/demo.png", // file url of the album cover image
"tags": [], // Optional array of tags associated with the album
"media_type": "Image/Pdf", // Type of media in the album: "Image/Pdf" or "Video"
"media_images": [ // Applicable if mediaType is "Image/Pdf". Array of file url.
"file_url/demo.png",
"file_url/test.jpg",
],
"video_topic": "Testing", // Applicable if mediaType is "Video". Topic of the video.
"video_url": "video url" // Applicable if mediaType is "Video". URL of the video.
}
]Mandatory Parameters
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| name | Text | Name of the album | Demo |
| year | format | Academic year for the album | 2024-2025 |
| date | date | Date of the album (YYYY-MM-DD format is preferred for consistency) | 2025-12-12 |
Optional Parameters
The optional parameters in the HTTP API are tabulated below:
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| album_type | Text | Type of album: "All" for school-wide, "Division" for specific divisions | All or Division |
| select_division | Array | Applicable only if album_type is "Division". Array of division identifiers. | [JR.KG-A,1-A] |
| description | Text | Optional description for the album | |
| upload_cover_image_name | Text | file url of the album cover image | file_url/demo.png |
| tag | Text | Optional array of tags associated with the album | [] |
| media_type | Text | Type of media in the album: "Image/Pdf" or "Video | Image/Pdf or Video |
| media_images | Array | Applicable if mediaType is "Image/Pdf". Array of file url. | [file_url/demo.png,file_url/test.jpg] |
| video_topic | text | Applicable if mediaType is "Video". Topic of the video. | testing |
| video_url | text | Applicable if mediaType is "Video". URL of the video. | video Url |
Notes:
- The
datefield should ideally follow theYYYY-MM-DDformat for better interoperability. - The
select_divisionarray is only relevant whenalbum_typeis set to "Division". - The fields
media_images,video_topic, andvideo_urlare conditionally required based on themedia_type.
