Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
edubridge learning management system

Topics

  • Introduction
  • Servers

Endpoints

  • AcademicYear
    • Academic year controller create v1 POST
    • Academic year controller find all v1 GET
    • Academic year controller find one v1 GET
    • Academic year controller remove v1 DELETE
    • Academic year controller update v1 PATCH
    • Academic year controller get active year v1 GET
  • Admin
    • Admin controller connect admin to institution v1 PATCH
    • Admin controller disconnect admin from institution v1 PATCH
    • Admin controller get admin institutions v1 GET
  • Admin Config
    • Get AI authenticity threshold GET
    • Set AI authenticity threshold PATCH
  • Assignments
    • Get assignment by ID GET
    • Delete assignment DELETE
    • Update assignment details PATCH
    • Submit assignment (student) POST
    • Get all submissions for an assignment (lecturer/admin) GET
    • Grade a single assignment submission (admin/lecturer) POST
    • Grade all submitted assignment submissions (lecturer/admin) POST
    • Remove material from assignment DELETE
    • Add content to assignment POST
    • Delete assignment content DELETE
    • Update assignment content PATCH
  • Authentication
    • User Login POST
    • Refresh Access Token POST
    • Send Password Reset Token POST
    • Confirm Password Reset Token POST
    • Reset Password POST
    • User Logout GET
  • CATs (Continuous Assessment Tests)
    • Create a new CAT (Continuous Assessment Test) POST
    • Get CAT details by ID GET
    • Delete a CAT DELETE
    • Update CAT details PATCH
    • Get all CATs for a unit GET
    • Update CAT status PATCH
    • Add a question to CAT POST
    • Delete a question from CAT DELETE
    • Update a CAT question PATCH
    • Start a new CAT attempt POST
    • Submit CAT attempt POST
    • Get student attempts for a CAT GET
    • Get all attempts for a CAT (lecturer/admin) GET
    • Get attempt details GET
    • Grade CAT attempt POST
    • Grade all submitted CAT attempts for a CAT (lecturer/admin) POST
    • Manually grade an unstructured question POST
  • Cohort Promotion
    • Promote a cohort to a new semester and update enrollments POST
  • Cohorts
    • Cohorts controller create v1 POST
    • Cohorts controller find all v1 GET
    • Cohorts controller find one v1 GET
    • Cohorts controller remove v1 DELETE
    • Cohorts controller update v1 PATCH
    • Cohorts controller find one full v1 GET
    • Cohorts controller find by department v1 GET
  • Courses
    • Courses controller create v1 POST
    • Courses controller find all v1 GET
    • Courses controller find by dept v1 GET
    • Courses controller link to departments v1 POST
    • Courses controller find one v1 GET
    • Courses controller find one full v1 GET
    • Courses controller update v1 PATCH
    • Courses controller remove v1 DELETE
  • Departments
    • Department controller create v1 POST
    • Department controller find all v1 GET
    • Department controller find one v1 GET
    • Department controller remove v1 DELETE
    • Department controller update v1 PATCH
    • Get all exam periods for a department GET
  • Exam Periods
    • List exam periods GET
    • Create exam period (admin only) POST
    • Get exam period by id GET
    • Delete exam period (admin only) DELETE
    • Update exam period (admin only) PATCH
    • Scan active/upcoming exam periods (admin only) GET
    • Link department to exam period POST
    • Unlink department from exam period DELETE
    • Get all departments associated with exam period GET
  • Exams
    • Get exam details GET
    • Delete an exam DELETE
    • Update exam details PATCH
    • Add a question to exam POST
    • Delete exam question DELETE
    • Update exam question PATCH
    • Start a new exam attempt POST
    • Submit exam attempt POST
    • Get all attempts for an exam GET
    • Grade a single exam attempt POST
    • Grade all submitted exam attempts in batch POST
  • File Uploader
    • Upload files for different resource types POST
  • Institute
    • Institute controller create v1 POST
    • Institute controller find all v1 GET
    • Institute controller find one v1 GET
    • Institute controller remove v1 DELETE
    • Institute controller update v1 PATCH
  • IntakePeriod
    • Intake period controller get periods by course v1 GET
    • Intake period controller get intake period v1 GET
    • Intake period controller get periods by academic year v1 GET
  • Lecturer Management
    • Get Lecturer Profile GET
    • Get Comprehensive Lecturer Dashboard GET
    • Get All Unit Offerings for Lecturer GET
    • Get Detailed Unit Offering Statistics GET
    • Get Students in Lecturer's Units GET
    • Get Student Feedback for Lecturer GET
    • Get Lecturer's Assignments GET
    • Get Lecturer's CATs (Continuous Assessment Tests) GET
    • Get Lecturer's Exams GET
    • Get Comprehensive Unit Grades and Analytics GET
  • Online Lessons
    • Get online lesson details GET
    • Delete an online lesson DELETE
    • Update online lesson PATCH
    • Add material to online lesson POST
    • Remove material from online lesson PATCH
  • Semesters
    • Semesters controller create v1 POST
    • Semesters controller find all v1 GET
    • Semesters controller find one v1 GET
    • Semesters controller remove v1 DELETE
    • Semesters controller update v1 PATCH
  • Student
    • Get Student Dashboard GET
    • Get Student Profile GET
    • Update Student Profile PUT
    • Get Active Units GET
    • Get All Units GET
    • Get Detailed Unit Information GET
    • Get aggregated materials for a student or unit offering GET
    • Get Student Grades GET
    • Get Upcoming Assessments GET
    • Get Student Notifications GET
    • Get Student Enrollments (Legacy) GET
    • Get Student Results (Legacy) GET
    • Get Student Exams (Legacy) GET
    • Get Student Courses (Legacy Alias) GET
    • Get Current Units (Legacy Alias) GET
    • Get Student Attendance (Not Implemented) GET
    • Get Student Fees (Not Implemented) GET
    • Get Student Timetable (Not Implemented) GET
    • Get Student Messages (Not Implemented) GET
    • Get Unit Progress Summary GET
    • Update Lesson Progress POST
    • Get Resume Information GET
    • Get Filtered Assessments GET
    • Get Assessment Statistics GET
    • Get Student Attempts GET
    • Create Assessment Attempt POST
    • Get assignment questions GET
    • Get CAT questions GET
    • Get CAT preview GET
    • Get assignment preview GET
    • Get exam preview GET
    • Get exam questions GET
    • Validate attempt GET
  • StudentEnrollment
    • Student enrollment controller find all v1 GET
    • Student enrollment controller create v1 POST
    • Student enrollment controller find one v1 GET
    • Student enrollment controller remove v1 DELETE
    • Student enrollment controller update v1 PATCH
  • System
    • Health Check GET
    • System Status GET
    • API Information GET
    • Detailed Uptime Information GET
    • Version Information GET
    • Debug Sentry Error GET
  • Topics
    • Get topic details GET
    • Delete a topic DELETE
    • Update topic details PATCH
    • Get all lessons for a topic GET
  • Unit
    • Unit controller create unit version v1 POST
    • Unit controller find one v1 GET
    • Unit controller findallversions v1 GET
    • Unit controller get specific version v1 GET
    • Unit controller connect unit to course v1 PATCH
    • Unit controller get all unit offerings v1 GET
    • Unit controller create unit instance v1 POST
    • Unit controller get specific instance v1 GET
    • Unit controller update instance v1 PATCH
    • Unit controller get specific instance full v1 GET
  • Unit Instance Management
    • Create a new topic in unit POST
    • Get all topics for unit GET
    • Create a new lesson in topic POST
    • Create a new online lesson POST
    • Get all online lessons for unit GET
    • Create a new assignment POST
    • Get assignments by access level GET
    • Get active assignments GET
    • Create a new CAT POST
    • Get CATs by access level GET
    • Create a new exam POST
    • Get exams for unit GET
  • Unit Offerings
    • Get All Unit Offerings GET
    • Create Unit Offering POST
    • Get Unit Offering Details GET
    • Delete Unit Offering DELETE
    • Update Unit Offering PATCH
    • Get Unit Offerings by Course Intake GET
    • Get Unit Offerings by Lecturer GET
    • Get Unit Offerings by Semester GET
    • Get Unit Offerings by Unit Version GET
  • Units
    • Units controller create v1 POST
    • Units controller find all v1 GET
    • Units controller find one v1 GET
    • Units controller update v1 PATCH
    • Units controller get unit version v1 GET
  • User Management
    • Get Current User Profile GET
    • Find User by ID GET
    • Soft Delete User DELETE
    • Update User Status PATCH
  • User Registration
    • General User Registration POST
    • Register Student User POST
    • Register Lecturer User POST
    • Batch Student Registration POST
    • Batch Lecturer Registration POST
  • Users Management
    • Get All Users GET
    • Get Users by Role GET
  • materials
    • Get all materials for a specific topic GET
    • Get all materials for a unit offering GET
    • Get materials by file type within a unit GET
    • Search materials within a unit offering GET
    • Get detailed information about a specific material GET
  • normal lesson
    • Normal lesson controller get lesson v1 GET
    • Normal lesson controller delete lesson v1 DELETE
    • Normal lesson controller update lesson v1 PATCH
    • Normal lesson controller add lesson content v1 POST
    • Normal lesson controller delete lesson content v1 DELETE
    • Normal lesson controller update lesson content v1 PATCH
    • Get all materials for a specific lesson GET
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
edubridge learning management system

IntakePeriod

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown