Skip to content

API ​

All endpoints are on the university's own address, e.g. https://<university>.<platform domain>, and need a logged-in user. Each call only returns and changes what the user's roles allow (roles).

EntityEndpoint
AI Chat/api/lms/ai_chat
AI Study Pack/api/lms/ai_study_pack
AI Tutor Topic/api/lms/ai_tutor_topic
Assignment Submission/api/lms/assignment_submission
Attendance/api/lms/attendance
Batch/api/lms/batch
Batch Semester/api/lms/batch_semester
Batch Enrolment/api/lms/batch_student
Chapter/api/lms/chapter
Chapter Coverage/api/lms/chapter_progress
Classroom/api/lms/classroom
Cohort/api/lms/cohort
Cohort Batch/api/lms/cohort_batch
Content Progress/api/lms/content_progress
Division/api/lms/division
Holiday/api/lms/holiday
Lecture Session/api/lms/lecture_session
Topic Covered/api/lms/lecture_topic
Material Division/api/lms/material_division
Material Recipient/api/lms/material_recipient
Practice Session/api/lms/practice_session
Previous Year Paper/api/lms/previous_paper
Project / Internship Task/api/lms/project
Project Submission/api/lms/project_submission
Question Bank Item/api/lms/question_bank_item
Quiz / Test/api/lms/quiz
Quiz Answer/api/lms/quiz_answer
Quiz Attempt/api/lms/quiz_attempt
Quiz Question/api/lms/quiz_question
Research Scholar Check-in/api/lms/scholar_attendance
Study Document/api/lms/study_document
Study Material/api/lms/study_material
Study Plan/api/lms/study_plan
Teaching Allocation/api/lms/teaching_allocation
Weekly Timetable Slot/api/lms/timetable_slot
Online Viva/api/lms/viva

Events ​

DirectionEvent
emitslms.batch_student.enrolled
emitslms.study_material.published
emitslms.assignment_submission.submitted
emitslms.assignment_submission.graded
emitslms.quiz_attempt.submitted
emitslms.quiz_attempt.graded
emitslms.lecture_session.cancelled
emitslms.lecture_session.finalized
emitslms.attendance.recorded
emitslms.project_submission.graded
emitslms.ai_study_pack.published
listens tocore.student.created

Settings ​

Each university sets these from its admin screen.

SettingTypeDefaultLabel
attendanceThresholdPercentnumber75Minimum attendance % before a student is a defaulter
geoRadarRadiusMetresnumber50Default geo-radar radius for self-marked attendance (metres)
faceVerificationDefaultcheckfalseRequire face verification on new lecture sessions
studentPhotoRequiredForAttendancecheckfalseStudent must have a profile photo to self-mark attendance
facultyBackdateAttendanceDaysnumber0Days in the past a teacher may mark attendance (0 = today only)
scholarCheckInPhotoRequiredcheckfalseResearch scholars must upload a photo at check-in
scholarCheckOutPhotoRequiredcheckfalseResearch scholars must upload a photo at check-out
scholarBackdateAllowedcheckfalseAdmins may record past research-scholar attendance
facultyCanCreateChapterschecktrueTeachers may create and edit chapters
quizMaxAttemptsnumber1Attempts allowed per quiz
allowLateSubmissionschecktrueAccept assignment submissions after the due date (marked Late)
aiFeaturesEnabledchecktrueEnable AI study tools (tutor, notes, doubt solver, study plans)
aiDefaultLanguagetext"English"Default language for AI-generated notes and tutoring
maxUploadMbnumber50Largest file a user may upload (MB)

Edulab Bench developer documentation