✨ Study Material
Endpoint : /study-material (GET method expected)
Example API Response
js
[
{
"year": "2024-2025", // Academic year for the study material
"title": "Demo", // Optional title for the study material
"studyMaterialType": "Class", // Type of study material: "School" or "Class"
"standard": "JR.KG", // Standard or grade for the study material
"divisions": [ // Applicable if studyMaterialType is "Class". Array of division identifiers.
"A",
"B"
],
"subject": "ENGLISH", // Subject of the study material
"chapter": "", // Optional chapter information
"description": "", // Optional description for the study material
"upload_files_name": [ // Array of file url for the uploaded study material files.
"file_url/demo.png",
"file_url/test.jpg"
],
"tags": [] // Optional array of tags associated with the study material
}
]Mandatory Parameters
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| title | Text | title of the study-material | Demo |
| year | format | Academic year for the study material | 2024-2025 |
| date | date | Date of the album (YYYY-MM-DD format is preferred for consistency) | 2025-12-12 |
| upload_files_name | Array | Array of file url for the uploaded study material files. | [file_url/demo.png,file_url/test.jpg] |
Optional Parameters
The optional parameters in the HTTP API are tabulated below:
| Name | Parameter | Description | Expected Values |
|---|---|---|---|
| study_material_type | Text | Type of study material: "School" or "Class" | School or Class |
| standard | Text | Standard for the study material | JR.KG |
| division | Array | Applicable if studyMaterialType is "Class". Array of division identifiers. | [A,B] |
| subject | Text | Subject of the study material | English |
| chapter | Text | Optional chapter information | |
| description | Text | Optional description for the study material | |
| tag | Array | Optional array of tags associated with the study material | [] |
Notes:
- The
divisionarray is only relevant whenstudy_material_typeis "Class". - Type of study material: "School" or "Class"
