/api/v1/college/statsCollege overview stats
student:viewManage department and semester structures, electives, internal marks, placements and research records.
Intended access: Assigned account with the required permissions.
student:viewstudent:createstudent:updatestudent:deleteUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
An assigned school account with the required permissions.
Semesters is part of the documented workflow.
Electives and enrollment is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
name | string | Optional |
code | string | Required by declaration |
hodStaffId | string | Optional |
description | string | Optional |
totalSeats | number | Optional |
departmentId | string | Required by declaration |
semesterNo | number | Required by declaration |
type | SemesterType | Required by declaration |
startDate | string | Optional |
endDate | string | Optional |
totalCredits | number | Optional |
isActive | boolean | Optional |
subjectId | string | Required by declaration |
semesterId | string | Required by declaration |
maxStudents | number | Optional |
credits | number | Optional |
teacherStaffId | string | Optional |
status | string | Optional |
electiveId | string | Required by declaration |
studentId | string | Required by declaration |
assignment1 | number | Optional |
assignment2 | number | Optional |
midSem | number | Optional |
attendance | number | Optional |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.
/api/v1/college/statsCollege overview stats
student:view/api/v1/college/departmentsList all departments
student:view/api/v1/college/departmentsCreate a department
student:createDeclared request fields: name (required), code (required), hodStaffId (optional), description (optional), totalSeats (optional).
/api/v1/college/departments/:idUpdate a department
student:updateDeclared request fields: name (optional), hodStaffId (optional), description (optional), totalSeats (optional).
/api/v1/college/departments/:idDelete a department
student:delete/api/v1/college/semestersList semesters (filter by departmentId)
student:view/api/v1/college/semestersCreate a semester
student:createDeclared request fields: name (required), departmentId (required), semesterNo (required), type (required), startDate (required), endDate (required), totalCredits (optional).
/api/v1/college/semesters/:idUpdate a semester
student:updateDeclared request fields: name (optional), startDate (optional), endDate (optional), totalCredits (optional), isActive (optional).
/api/v1/college/electivesList elective subjects (filter by semesterId)
student:view/api/v1/college/electivesCreate an elective subject offering
student:createDeclared request fields: subjectId (required), semesterId (required), maxStudents (optional), credits (optional), teacherStaffId (optional).
/api/v1/college/electives/:idUpdate elective (status, max students)
student:updateDeclared request fields: maxStudents (optional), status (optional), teacherStaffId (optional).
/api/v1/college/electives/enrollEnroll a student in an elective
student:createDeclared request fields: electiveId (required), studentId (required).
/api/v1/college/internal-marksList internal marks (filter by semesterId, studentId)
student:view/api/v1/college/internal-marksCreate internal marks entry
student:createDeclared request fields: studentId (required), subjectId (required), semesterId (required), assignment1 (optional), assignment2 (optional), midSem (optional), attendance (optional), practical (optional), maxMarks (optional).
/api/v1/college/internal-marks/:idUpdate internal marks
student:updateDeclared request fields: assignment1 (optional), assignment2 (optional), midSem (optional), attendance (optional), practical (optional).
/api/v1/college/placementsList placement records (filter by status)
student:view/api/v1/college/placementsCreate a placement record
student:createDeclared request fields: studentId (required), companyName (required), role (optional), ctcLpa (optional), appliedAt (optional), notes (optional).
/api/v1/college/placements/:idUpdate placement status
student:updateDeclared request fields: status (optional), ctcLpa (optional), offerDate (optional), notes (optional).
/api/v1/college/researchList research projects (filter by departmentId)
student:view/api/v1/college/researchCreate a research project
student:createDeclared request fields: title (required), departmentId (required), piStaffId (optional), description (optional), fundingAmount (optional), fundingSource (optional), startDate (optional), endDate (optional), coInvestigatorIds (optional).
/api/v1/college/research/:idUpdate a research project
student:updateDeclared request fields: title (optional), description (optional), fundingAmount (optional), status (optional), endDate (optional).
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.