Skip to content

✨ 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

NameParameterDescriptionExpected Values
titleTexttitle of the study-materialDemo
yearformatAcademic year for the study material2024-2025
datedateDate of the album (YYYY-MM-DD format is preferred for consistency)2025-12-12
upload_files_nameArrayArray 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:

NameParameterDescriptionExpected Values
study_material_typeTextType of study material: "School" or "Class"School or Class
standardTextStandard for the study materialJR.KG
divisionArrayApplicable if studyMaterialType is "Class". Array of division identifiers.[A,B]
subjectTextSubject of the study materialEnglish
chapterTextOptional chapter information
descriptionTextOptional description for the study material
tagArrayOptional array of tags associated with the study material[]

Notes:

  • The division array is only relevant when study_material_type is "Class".
  • Type of study material: "School" or "Class"

Thank You!