AVKUL ERPDocs
MODULE GUIDE · 11 OCT 2026

Family & personal workspace

Let families, learners and staff see only their linked children or personal records.

Try guided demo →Download guide ↓
Family & personal workspace — illustrated workflow banner
OVERVIEW

What you can do

01

Linked children

02

Attendance and fees

03

Published results

04

Homework and courses

05

Timetable

06

Library

07

PTM

08

Transport

09

Personal documents

BEFORE YOU BEGIN

Access & setup

Intended access: Linked parent / learner account.

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

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

  1. 01

    Sign in with the assigned account

    An assigned school account with the required permissions.

  2. 02

    Select the linked child where a selector is available

    Attendance and fees is part of the documented workflow.

  3. 03

    Open the relevant learning or school-service screen

    Published results is part of the documented workflow.

  4. 04

    Review the record or complete the permitted self-service action

    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.

FieldDeclared typeInput
tokenstringRequired by declaration
platformstringRequired by declaration
studentIdstringOptional
interestsstringOptional
psychometricRecord<string, number>Optional
opportunityTypestringOptional
interestAreastringOptional
CURRENT BEHAVIOUR

Rules & current limits

  • Child ownership is resolved on the server. Family views omit staff-only notes, rosters and administrative controls.

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 family & personal workspace

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.

60 source-declared operations
GET/api/v1/me/library

Library

Authenticated scope and endpoint-specific rules
POST/api/v1/me/library/reservations

Library Reserve

Authenticated scope and endpoint-specific rules
POST/api/v1/me/library/reservations/:id/cancel

Library Cancel

Authenticated scope and endpoint-specific rules
POST/api/v1/me/library/issues/:id/renew

Library Renew

Authenticated scope and endpoint-specific rules
GET/api/v1/me/timetable

Timetable

Authenticated scope and endpoint-specific rules
GET/api/v1/me/children

Children

Authenticated scope and endpoint-specific rules
GET/api/v1/me/profile

Profile

Authenticated scope and endpoint-specific rules
GET/api/v1/me/attendance

Attendance

Authenticated scope and endpoint-specific rules
GET/api/v1/me/attendance/calendar

Attendance Calendar

Authenticated scope and endpoint-specific rules
GET/api/v1/me/health

My Health

Authenticated scope and endpoint-specific rules
GET/api/v1/me/certificates

My Certificates

Authenticated scope and endpoint-specific rules
GET/api/v1/me/wellbeing

My Wellbeing

Authenticated scope and endpoint-specific rules
GET/api/v1/me/documents

My Documents

Authenticated scope and endpoint-specific rules
GET/api/v1/me/payslips

The signed-in staff member's own payslips

Authenticated scope and endpoint-specific rules
GET/api/v1/me/payslips/:id

My Payslip

Authenticated scope and endpoint-specific rules
GET/api/v1/me/fees

Fees

Authenticated scope and endpoint-specific rules
GET/api/v1/me/fees/receipts/:id

Fee Receipt

Authenticated scope and endpoint-specific rules
GET/api/v1/me/results

Results

Authenticated scope and endpoint-specific rules
GET/api/v1/me/results/:id/print

Result Print

Authenticated scope and endpoint-specific rules
GET/api/v1/me/inbox

Inbox

Authenticated scope and endpoint-specific rules
GET/api/v1/me/inbox/unread-count

Unread Count

Authenticated scope and endpoint-specific rules
POST/api/v1/me/inbox/:id/read

Mark Read

Authenticated scope and endpoint-specific rules
POST/api/v1/me/inbox/read-all

Mark All Read

Authenticated scope and endpoint-specific rules
GET/api/v1/me/device-tokens

My Device Tokens

Authenticated scope and endpoint-specific rules
POST/api/v1/me/device-token

Register this device for push notifications

Authenticated scope and endpoint-specific rules

Declared request fields: token (required), platform (required).

DELETE/api/v1/me/device-token/:token

Stop this device receiving push (call on logout)

Authenticated scope and endpoint-specific rules
GET/api/v1/me/notices

Notices

Authenticated scope and endpoint-specific rules
GET/api/v1/me/complaints

Complaints

Authenticated scope and endpoint-specific rules
POST/api/v1/me/complaints

Create Complaint

Authenticated scope and endpoint-specific rules
GET/api/v1/me/ptm

My Ptm

Authenticated scope and endpoint-specific rules
POST/api/v1/me/ptm/bookings

Book Ptm

Authenticated scope and endpoint-specific rules
POST/api/v1/me/ptm/bookings/:id/change

Change Ptm

Authenticated scope and endpoint-specific rules
POST/api/v1/me/ptm/follow-ups/:id

Ptm Task

Authenticated scope and endpoint-specific rules
GET/api/v1/me/live-classes

Live Classes List

Authenticated scope and endpoint-specific rules
GET/api/v1/me/lms/courses

Lms Courses

Authenticated scope and endpoint-specific rules
GET/api/v1/me/lms/courses/:id

Lms Course

Authenticated scope and endpoint-specific rules
PATCH/api/v1/me/lms/lessons/:id/progress

Lms Lesson Progress

Authenticated scope and endpoint-specific rules
GET/api/v1/me/assignments

Assignments List

Authenticated scope and endpoint-specific rules
POST/api/v1/me/assignments/:id/files

Upload Homework

Authenticated scope and endpoint-specific rules
GET/api/v1/me/assignment-files/:id

Homework File

Authenticated scope and endpoint-specific rules
POST/api/v1/me/assignments/:id/submit

Submit Assignment

Authenticated scope and endpoint-specific rules
GET/api/v1/me/department-team

Department Team

Authenticated scope and endpoint-specific rules
GET/api/v1/me/alumni-directory

Alumni Directory

Authenticated scope and endpoint-specific rules
POST/api/v1/me/ask-copilot

Ask Copilot

Authenticated scope and endpoint-specific rules
GET/api/v1/me/learning-path

Learning Path

Authenticated scope and endpoint-specific rules
POST/api/v1/me/learning-path

Regenerate Learning Path

Authenticated scope and endpoint-specific rules
PATCH/api/v1/me/learning-path-items/:itemId

Update Learning Path Item

Authenticated scope and endpoint-specific rules
GET/api/v1/me/explains

List Explains

Authenticated scope and endpoint-specific rules
GET/api/v1/me/explains/:id

Get Explain

Authenticated scope and endpoint-specific rules
POST/api/v1/me/explains

Generate Explain

Authenticated scope and endpoint-specific rules
GET/api/v1/me/transport

Transport

Authenticated scope and endpoint-specific rules
GET/api/v1/me/bus-eta

Bus Eta

Authenticated scope and endpoint-specific rules
GET/api/v1/me/adaptive-exams

Adaptive Exams List

Authenticated scope and endpoint-specific rules
POST/api/v1/me/adaptive-exams/:examId/start

Start Adaptive Exam

Authenticated scope and endpoint-specific rules
GET/api/v1/me/adaptive-attempts/:attemptId

Get Adaptive Attempt

Authenticated scope and endpoint-specific rules
POST/api/v1/me/adaptive-attempts/:attemptId/answer

Answer Adaptive

Authenticated scope and endpoint-specific rules
POST/api/v1/me/adaptive-attempts/:attemptId/submit

Submit Adaptive

Authenticated scope and endpoint-specific rules
GET/api/v1/me/progress-story

Progress Story

Authenticated scope and endpoint-specific rules
POST/api/v1/me/career-twin

Career Twin

Authenticated scope and endpoint-specific rules

Declared request fields: studentId (optional), interests (optional), psychometric (optional).

POST/api/v1/me/alumni-opportunity

Alumni Opportunity

Authenticated scope and endpoint-specific rules

Declared request fields: studentId (optional), opportunityType (optional), interestArea (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/portal/askOpen ↗/en/portal/attendanceOpen ↗/en/portal/busOpen ↗/en/portal/complaintsOpen ↗/en/portal/examsOpen ↗/en/portal/explainOpen ↗/en/portal/feesOpen ↗/en/portal/homeworkOpen ↗/en/portal/journeyOpen ↗/en/portal/learning-pathOpen ↗/en/portal/leaveOpen ↗/en/portal/libraryOpen ↗/en/portal/live-classesOpen ↗/en/portal/live-classes/[id]Open ↗/en/portal/lmsOpen ↗/en/portal/lms/[id]Open ↗/en/portal/noticesOpen ↗/en/portalOpen ↗/en/portal/profileOpen ↗/en/portal/ptmOpen ↗/en/portal/resultsOpen ↗/en/portal/timetableOpen ↗/en/portal/wellbeingOpen ↗/en/school/my-departmentOpen ↗/en/school/my-payslipsOpen ↗

Keep exploring

Family guideAsk School Copilot →Family guideMy attendance →Family guideMy child’s bus →Family guideFamily complaints →