Methods
(async) change_password(old_password, new_password) → {Promise.<Object>}
Changes password for logged in student
Parameters:
| Name | Type | Description |
|---|---|---|
old_password |
string | Current password |
new_password |
string | New password |
- Source:
Throws:
-
On password change failure
- Type
- AccountAPIError
Returns:
Response indicating success/failure
- Type
- Promise.<Object>
(async) download_marks(semester)
Downloads marks PDF for a semester
Parameters:
| Name | Type | Description |
|---|---|---|
semester |
Semester | Semester object |
- Source:
Throws:
-
On download failure
- Type
- APIError
(async) get_attendance(header, semester) → {Promise.<Object>}
Gets attendance details for a semester
Parameters:
| Name | Type | Description |
|---|---|---|
header |
AttendanceHeader | Attendance header |
semester |
Semester | Semester object |
- Source:
Returns:
Attendance details
- Type
- Promise.<Object>
(async) get_attendance_meta() → {Promise.<AttendanceMeta>}
Gets attendance metadata including headers and semesters
- Source:
Returns:
Attendance metadata
- Type
- Promise.<AttendanceMeta>
(async) get_exam_events(semester) → {Promise.<Array.<ExamEvent>>}
Gets exam events for a semester
Parameters:
| Name | Type | Description |
|---|---|---|
semester |
Semester | Semester object |
- Source:
Returns:
Array of exam event objects
- Type
- Promise.<Array.<ExamEvent>>
(async) get_exam_schedule(exam_event) → {Promise.<Object>}
Gets exam schedule for an exam event
Parameters:
| Name | Type | Description |
|---|---|---|
exam_event |
ExamEvent | Exam event object |
- Source:
Returns:
Exam schedule details
- Type
- Promise.<Object>
(async) get_grade_card(semester) → {Promise.<Object>}
Gets grade card for a semester
Parameters:
| Name | Type | Description |
|---|---|---|
semester |
Semester | Semester object |
- Source:
Returns:
Grade card details
- Type
- Promise.<Object>
(async) get_personal_info() → {Promise.<Object>}
Gets personal information of logged in student
- Source:
Returns:
Student personal information
- Type
- Promise.<Object>
(async) get_registered_semesters() → {Promise.<Array.<Semester>>}
Gets list of registered semesters
- Source:
Returns:
Array of semester objects
- Type
- Promise.<Array.<Semester>>
(async) get_registered_subjects_and_faculties(semester) → {Promise.<Registrations>}
Gets registered subjects and faculty details for a semester
Parameters:
| Name | Type | Description |
|---|---|---|
semester |
Semester | Semester object |
- Source:
Returns:
Registration details
- Type
- Promise.<Registrations>
(async) get_semesters_for_exam_events() → {Promise.<Array.<Semester>>}
Gets semesters that have exam events
- Source:
Returns:
Array of semester objects
- Type
- Promise.<Array.<Semester>>
(async) get_semesters_for_grade_card() → {Promise.<Array.<Semester>>}
Gets semesters that have grade cards available
- Source:
Returns:
Array of semester objects
- Type
- Promise.<Array.<Semester>>
(async) get_semesters_for_marks() → {Promise.<Array.<Semester>>}
Gets semesters that have marks available
- Source:
Returns:
Array of semester objects
- Type
- Promise.<Array.<Semester>>
(async) get_sgpa_cgpa() → {Promise.<Object>}
Gets SGPA and CGPA details
- Source:
Returns:
SGPA and CGPA details
- Type
- Promise.<Object>
(async) get_student_bank_info() → {Promise.<Object>}
Gets bank account information of logged in student
- Source:
Returns:
Student bank information
- Type
- Promise.<Object>
(async) get_subject_daily_attendance(semester, subjectid, individualsubjectcode, subjectcomponentids) → {Promise.<Object>}
Gets attendance for every class of the subject for the semester.
Parameters:
| Name | Type | Description |
|---|---|---|
semester |
Semester | Semester object |
subjectid |
string | Subject ID |
individualsubjectcode |
string | Individual subject code |
subjectcomponentids |
Array.<string> | Array of subject component IDs |
- Source:
Returns:
Subject attendance details
- Type
- Promise.<Object>
(async) student_login(username, password, captchaopt) → {Promise.<WebPortalSession>}
Logs in a student user
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
username |
string | Student username | ||
password |
string | Student password | ||
captcha |
Object |
<optional> |
DEFCAPTCHA | CAPTCHA |
- Source:
Throws:
-
On login failure
- Type
- LoginError
Returns:
New session instance
- Type
- Promise.<WebPortalSession>