MODULE GUIDE · 11 OCT 2026

Student records & lifecycle

Maintain student profiles, guardians and documents, and manage campus release or school exit.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

Student directory

Profile 360

Guardians

Document review

Gate passes

Exit clearance

Transfer certificates

Readmission

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

student:viewstudent:updatestudent:managestudent:deletestudent:createstudent-exit:viewstudent-exit:createstudent-exit:manage

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
Create or open the student profile
An assigned school account with the required permissions.
02
Review guardian contacts and required documents
Profile 360 is part of the documented workflow.
03
Use the gate-pass workflow for an authorized early release
Guardians is part of the documented workflow.
04
Use clearance and exit workflows for withdrawal or transfer
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
`studentId`	string	Required by declaration
`reason`	string	Optional
`expectedOutAt`	string	Optional
`expectedBackAt`	string	Optional
`releaseToName`	string	Optional
`releaseToGuardianId`	string	Optional
`approve`	boolean	Required by declaration
`guardianId`	string	Optional
`releaseRelation`	string	Optional
`overrideReason`	string	Optional
`notes`	string	Optional
`type`	string	Required by declaration
`title`	string	Optional
`expiresAt`	string	Optional
`firstName`	string	Required by declaration
`middleName`	string	Optional
`lastName`	string	Optional
`admissionNo`	string	Required by declaration
`rollNo`	string	Optional
`gender`	string	Optional
`dateOfBirth`	string	Optional
`bloodGroup`	string	Optional
`sessionId`	string	Optional
`classId`	string	Optional

CURRENT BEHAVIOUR

Rules & current limits

Campus release is distinct from withdrawal from the school rolls. Transfer certificates require a valid exited record.

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 student records & lifecycle

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.

27 source-declared operations

GET/api/v1/gate-pass

List

student:view

GET/api/v1/gate-pass/currently-out

Students currently signed out of campus

student:view

GET/api/v1/gate-pass/student/:studentId/pickups

Who is on file to collect this student

student:view

POST/api/v1/gate-pass

Create

student:update

Declared request fields: studentId (required), reason (required), expectedOutAt (optional), expectedBackAt (optional), releaseToName (optional), releaseToGuardianId (optional).

POST/api/v1/gate-pass/:id/decision

Approve or turn down a gate pass

student:manage

Declared request fields: approve (required), reason (optional).

POST/api/v1/gate-pass/:id/release

Hand the student over at the gate

student:update

Declared request fields: guardianId (optional), releaseToName (optional), releaseRelation (optional), overrideReason (optional).

POST/api/v1/gate-pass/:id/return

Mark Returned

student:update

Declared request fields: notes (optional).

POST/api/v1/gate-pass/:id/cancel

Cancel

student:update

GET/api/v1/student-documents/expiring

Documents that have expired or are about to

student:view

GET/api/v1/student-documents/missing

Students with incomplete or unverified paperwork

student:view

GET/api/v1/student-documents/:studentId

List

student:view

POST/api/v1/student-documents/:studentId

Upload a document for a student

student:update

Declared request fields: type (required), title (optional), expiresAt (optional).

POST/api/v1/student-documents/verify/:id

Mark a document as checked against the original

student:manage

POST/api/v1/student-documents/reject/:id

Send a document back with a reason

student:manage

Declared request fields: reason (required).

DELETE/api/v1/student-documents/:id

Remove

student:delete

GET/api/v1/students

List

student:view

GET/api/v1/students/:id

Get

student:view

GET/api/v1/students/:id/profile-360

Get Profile360

student:view

POST/api/v1/students

Create

student:create

Declared request fields: firstName (required), middleName (optional), lastName (optional), admissionNo (required), rollNo (optional), gender (optional), dateOfBirth (optional), bloodGroup (optional), sessionId (optional), classId (optional), sectionId (optional), admissionDate (optional), phone (optional), email (optional).

PATCH/api/v1/students/:id

Update

student:update

DELETE/api/v1/students/:id

Remove

student:delete

GET/api/v1/students/exit/register

Students who have left, with TC numbers

student-exit:view

GET/api/v1/students/:id/clearance

What is blocking this student from leaving

student-exit:view

POST/api/v1/students/:id/exit

Take a student off the rolls and allocate a TC number

student-exit:create

Declared request fields: status (required), exitDate (optional), reason (optional), remark (optional), issueTc (optional), force (optional).

POST/api/v1/students/:id/readmit

Reverse an exit and put the student back on the rolls

student-exit:manage

Declared request fields: reason (optional), classId (optional), sectionId (optional).

POST/api/v1/students/:id/transfer-certificate

Generate the TC document for an exited student

student-exit:create

POST/api/v1/students/:id/guardians

Add Guardian

student:update

Declared request fields: firstName (required), lastName (optional), relationship (required), phone (optional), email (optional), isPrimary (optional), isFeePayer (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/gate-passOpen ↗/en/school/student-exitOpen ↗/en/school/studentsOpen ↗/en/school/students/[id]Open ↗

Student records & lifecycle

What you can do

Student directory

Profile 360

Guardians

Document review

Gate passes

Exit clearance

Transfer certificates

Readmission

Access & setup

How the workflow works

Create or open the student profile

Review guardian contacts and required documents

Use the gate-pass workflow for an authorized early release

Use clearance and exit workflows for withdrawal or transfer

Request fields to understand

Rules & current limits

Try student records & lifecycle

API & permissions reference

Open the actual application

Keep exploring