API Reference

class pyjiit.wrapper.Webportal

Class which implements the functionality for JIIT Webportal

get_attendance(header: AttendanceHeader, semester: Semester)

Parameters:

• header – An AttendanceHeader object

• semester – A Semester object

Returns:

A dictionary with attendance data

Raises:

APIError – Raised for generic API error

get_attendance_meta()

Returns:

AttendanceMeta object

Raises:

APIError – Raised for generic API error

get_captcha() → Captcha

Returns:

Captcha object with empty answer field

Raises:

APIError – Raised for generic API error

get_exam_events(semester: Semester)

Parameters:

semester – A Semester object

Returns:

A list of ExamEvent objects

Raises:

APIError – Raised for generic API error

get_exam_schedule(exam_event: ExamEvent)

Parameters:

exam_event – An ExamEvent object

Returns:

A dictionary with exam schedule data

Raises:

APIError – Raised for generic API error

get_registered_semesters()

Returns:

A list of Semester objects

Raises:

APIError – Raised for generic API error

get_registered_subjects_and_faculties(semester: Semester)

Parameters:

semester – A Semester object

Returns:

A Registrations object

Raises:

APIError – Raised for generic API error

get_semesters_for_exam_events()

Returns:

A list of Semester objects

Raises:

APIError – Raised for generic API error

get_student_bank_info()

Returns:

A dictionary with student bank info

Raises:

APIError – Raised for generic API error

set_password(old_pswd: str, new_pswd: str)

Parameters:

• old_pswd – Old password string

• new_pswd – New password string

Raises:

APIError – Raised for generic API error

student_login(username: str, password: str, captcha: Captcha) → WebportalSession

Parameters:

• username – A username

• password – A password

• captcha – Captcha object

Returns:

WebportalSession object (Also sets the internal session variable to this)

Raises:

LoginError – Raised for any error in the remote API while Logging in

class pyjiit.wrapper.WebportalSession(resp: dict)

Class which contains session cookies for JIIT Webportal

get_headers()

Returns:

A dictionary with Authorization HTTP headers

class pyjiit.token.Captcha(captcha: str, hidden: str, image: str)

Class which contains captcha answer, captcha id (hidden) and image in base64

payload() → dict

Returns:

A dictionary with captcha as required for login request

class pyjiit.attendance.AttendanceHeader(branchdesc: str, name: str, programdesc: str, stynumber: str)

Class which contains header info in the Attendance API

class pyjiit.attendance.Semester(registration_code: str, registration_id: str)

Class which contains Semester info

class pyjiit.exam.ExamEvent(exam_event_code: str, event_from: int, exam_event_desc: str, registration_id: str, exam_event_id: str)

Class containing exam event info

class pyjiit.registration.RegisteredSubject(employee_name: str, employee_code: str, minor_subject: str, remarks: str, stytype: str, credits: int, subject_code: str, subject_component_code: str, subject_desc: str, subject_id: str, audtsubject: str)

Class containing registered subject info like Lecturer name, credits, etc

class pyjiit.registration.Registrations(resp: dict)

Class containing all registered subjects and total course credits for the semester

exception pyjiit.exceptions.APIError

exception pyjiit.exceptions.AccountAPIError

exception pyjiit.exceptions.LoginError

exception pyjiit.exceptions.NotLoggedIn

exception pyjiit.exceptions.SessionError

exception pyjiit.exceptions.SessionExpired