MODULE GUIDE · 11 OCT 2026

Hostel, rooms & roll call

Manage residence capacity, room/bed allocations, visitor logs and nightly attendance.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

Hostels and rooms

Beds

Resident allocations

Visitor check-in/out

Night roll call

Missing residents

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

An assigned school account with the required permissions.
The academic, student or staff setup used by this workflow.

Required permission keys

hostel:viewhostel:createhostel:updatehostel:delete

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

STEP BY STEP

How the workflow works

01
Set up the hostel, rooms and beds
An assigned school account with the required permissions.
02
Allocate eligible residents to available accommodation
Beds is part of the documented workflow.
03
Record and check out permitted visitors
Resident allocations is part of the documented workflow.
04
Open the roll call, mark residents and close the register
Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

Field	Declared type	Input
`name`	string	Required by declaration
`type`	string	Optional
`wardenStaffId`	string	Optional
`address`	string	Optional
`hostelId`	string	Required by declaration
`roomNo`	string	Required by declaration
`floor`	string	Optional
`capacity`	number	Optional
`fare`	number	Optional
`roomId`	string	Required by declaration
`bedNo`	string	Required by declaration
`studentId`	string	Optional
`bedId`	string	Required by declaration
`fromDate`	string	Required by declaration
`toDate`	string	Optional
`visitorName`	string	Required by declaration
`purpose`	string	Optional
`idProof`	string	Optional
`outTime`	string	Optional
`date`	string	Optional
`marks`	ResidentMarkDto[]	Required by declaration
`force`	boolean	Optional
`notes`	string	Optional

CURRENT BEHAVIOUR

Rules & current limits

Capacity and allocation state must be reviewed before assignment. Family notification delivery depends on the available channel.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

LEARN BY DOING

Try hostel, rooms & roll call

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →

FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

28 source-declared operations

GET/api/v1/hostel/stats

Get Stats

hostel:view

GET/api/v1/hostel/my-allocation

My Allocation

Authenticated scope and endpoint-specific rules

GET/api/v1/hostel/hostels

List Hostels

hostel:view

POST/api/v1/hostel/hostels

Create Hostel

hostel:create

Declared request fields: name (required), type (optional), wardenStaffId (optional), address (optional).

PATCH/api/v1/hostel/hostels/:id

Update Hostel

hostel:update

DELETE/api/v1/hostel/hostels/:id

Remove Hostel

hostel:delete

GET/api/v1/hostel/rooms

List Rooms

hostel:view

POST/api/v1/hostel/rooms

Create Room

hostel:create

Declared request fields: hostelId (required), roomNo (required), floor (optional), capacity (optional), fare (optional).

PATCH/api/v1/hostel/rooms/:id

Update Room

hostel:update

DELETE/api/v1/hostel/rooms/:id

Remove Room

hostel:delete

GET/api/v1/hostel/beds

List Beds

hostel:view

POST/api/v1/hostel/beds

Create Bed

hostel:create

Declared request fields: roomId (required), bedNo (required).

PATCH/api/v1/hostel/beds/:id

Update Bed

hostel:update

DELETE/api/v1/hostel/beds/:id

Remove Bed

hostel:delete

GET/api/v1/hostel/allocations

List Allocations

hostel:view

POST/api/v1/hostel/allocations

Create Allocation

hostel:create

Declared request fields: studentId (required), bedId (required), fromDate (required), toDate (optional), fare (optional).

PATCH/api/v1/hostel/allocations/:id

Update Allocation

hostel:update

POST/api/v1/hostel/allocations/:id/vacate

Vacate Allocation

hostel:update

GET/api/v1/hostel/visitor-logs

List Visitor Logs

hostel:view

POST/api/v1/hostel/visitor-logs

Create Visitor Log

hostel:create

Declared request fields: hostelId (optional), visitorName (required), studentId (optional), purpose (optional), idProof (optional).

PATCH/api/v1/hostel/visitor-logs/:id

Update Visitor Log

hostel:update

POST/api/v1/hostel/visitor-logs/:id/checkout

Checkout Visitor

hostel:update

Declared request fields: outTime (optional).

DELETE/api/v1/hostel/visitor-logs/:id

Remove Visitor Log

hostel:delete

GET/api/v1/hostel/roll-call/missing

Residents not accounted for, and hostels with no roll call at all

hostel:view

GET/api/v1/hostel/roll-call/:id

hostel:view

POST/api/v1/hostel/roll-call/open

Open tonight's register for a hostel

hostel:update

Declared request fields: hostelId (required), date (optional).

POST/api/v1/hostel/roll-call/:id/mark

Mark

hostel:update

Declared request fields: marks (required).

POST/api/v1/hostel/roll-call/:id/close

Close the night; families of absent residents are told

hostel:update

Declared request fields: force (optional), notes (optional).

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/school/hostelOpen ↗

Hostel, rooms & roll call

What you can do

Hostels and rooms

Beds

Resident allocations

Visitor check-in/out

Night roll call

Missing residents

Access & setup

How the workflow works

Set up the hostel, rooms and beds

Allocate eligible residents to available accommodation

Record and check out permitted visitors

Open the roll call, mark residents and close the register

Request fields to understand

Rules & current limits

Try hostel, rooms & roll call

API & permissions reference

Open the actual application

Keep exploring