Appearance
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).
| Entity | Endpoint |
|---|---|
| Room Allotment | /api/hostel/allotment |
| Amenity | /api/hostel/amenity |
| Hostel Application | /api/hostel/application |
| Attendance | /api/hostel/attendance |
| Hostel Cancellation | /api/hostel/cancellation |
| Complaint | /api/hostel/complaint |
| Complaint Comment | /api/hostel/complaint_comment |
| Hostel Fee Head | /api/hostel/fee_head |
| Hostel Fee Template | /api/hostel/fee_template |
| Guest Stay | /api/hostel/guest_stay |
| Hostel | /api/hostel/hostel |
| Hostel Amenity | /api/hostel/hostel_amenity |
| Hostel Semester Rule | /api/hostel/hostel_semester_rule |
| Hostel Staff Assignment | /api/hostel/hostel_staff |
| Leave / Gate Pass | /api/hostel/leave_request |
| Mess Menu Item | /api/hostel/mess_menu_item |
| Mess Plan | /api/hostel/mess_plan |
| Resident Profile | /api/hostel/resident_profile |
| Room | /api/hostel/room |
| Room Type | /api/hostel/room_type |
| Room Type Amenity | /api/hostel/room_type_amenity |
| Seat Quota | /api/hostel/seat_quota |
| Seat Quota Plan | /api/hostel/seat_quota_plan |
Events
| Direction | Event |
|---|---|
| emits | hostel.application.submitted |
| emits | hostel.application.approved |
| emits | hostel.application.rejected |
| emits | hostel.allotment.created |
| emits | hostel.allotment.vacated |
| emits | hostel.cancellation.created |
| listens to | fees.payment.received |
Settings
Each university sets these from its admin screen.
| Setting | Type | Default | Label |
|---|---|---|---|
allotmentNeedsFee | check | true | Allot a bed only after the hostel fee is paid |
selfBedSelectionEnabled | check | false | Students may pick their own room and bed (per-hostel semesters in Hostel > Semester rules) |
seatReservationEnabled | check | false | Enforce the active seat quota plan on student bookings |
openPaymentSemestersEnabled | check | false | Restrict payable semesters to those opened per hostel (Hostel > Semester rules) |
holdOtherApplications | check | true | Put a student's other applications on hold once one is accepted |
semestersPerYear | number | 2 | Semesters per year of study (used for fee and bed-selection rules) |
paymentLinkValidHours | number | 48 | Hours an office-issued payment link stays valid |