API Reference

Purpose and Scope

This document provides comprehensive reference documentation for all public classes, methods, constants, and interfaces exposed by the jsjiit library. It serves as the authoritative guide to the library's API surface, detailing the types, signatures, and purposes of all exported constructs.

For implementation details and internal architecture, see Architecture and Design. For step-by-step usage examples, see Quick Start Guide. For detailed information about specific API categories, refer to the subsections below.

Sources: src/index.js1-32

Public API Surface

The jsjiit library exports its entire public API through src/index.js1-32 All imports should be made from this module or its compiled distribution bundles.

Complete Export Table

Sources: src/index.js1-32

API Architecture Diagram

The following diagram illustrates the relationship between the primary API classes and their dependencies:

Sources: src/index.js1-32 src/wrapper.js75-719

WebPortal Class Overview

The WebPortal class is the primary interface for all portal interactions. It provides methods organized into functional categories.

Method Categories

Sources: src/wrapper.js75-719

Method Reference Table

For detailed documentation of each method, see:

• Authentication and Session Management
• Attendance Methods
• Registration and Subject Methods
• Exam and Schedule Methods
• Academic Records Methods
• Feedback and Account Methods

Sources: src/wrapper.js168-719 README.md19-96

WebPortalSession Class

The WebPortalSession class represents an authenticated session with the JIIT web portal. It is created automatically by WebPortal.student_login() and should not be instantiated directly.

Session Properties

Session Methods

Sources: src/wrapper.js25-70

Data Models

The library provides typed data model classes to represent portal data structures. These classes parse and structure raw API responses.

Data Model Hierarchy

For complete documentation of data model properties and methods, see Data Models.

Sources: src/attendance.js src/registration.js src/exam.js

Error Handling

The library provides a hierarchy of exception classes for different error scenarios. All exceptions extend from Error.

Exception Hierarchy

Exception Reference

For detailed error handling strategies and examples, see Error Handling.

Sources: src/exceptions.js src/wrapper.js97-157 src/wrapper.js679-719

Constants and Utilities

Constants

API

const API = "https://webportal.jiit.ac.in:6011/StudentPortalAPI"

Base endpoint URL for all API requests. Defined in src/wrapper.js14

DEFCAPTCHA

const DEFCAPTCHA = { captcha: "phw5n", hidden: "gmBctEffdSg=" }

Default CAPTCHA bypass values used by student_login(). Defined in src/wrapper.js20

Utility Functions

generate_local_name()

async generate_local_name(): Promise<string>

Generates a LocalName header value required for all API requests. This function is exported for advanced use cases but is typically called internally by the library. Defined in src/encryption.js

Sources: src/wrapper.js14-20 src/encryption.js src/index.js10

API Request Flow

The following diagram illustrates the typical request flow through the WebPortal class:

Sources: src/wrapper.js97-157 src/wrapper.js679-719

Authentication Decorator Pattern

All methods requiring authentication are decorated with the authenticated decorator. This pattern is implemented at src/wrapper.js679-719

Authenticated Methods List

The following methods are automatically wrapped with authentication checks:

const authenticatedMethods = [
  "get_personal_info",
  "get_student_bank_info",
  "change_password",
  "get_attendance_meta",
  "get_attendance",
  "get_subject_daily_attendance",
  "get_registered_semesters",
  "get_registered_subjects_and_faculties",
  "get_semesters_for_exam_events",
  "get_exam_events",
  "get_exam_schedule",
  "get_semesters_for_marks",
  "download_marks",
  "get_semesters_for_grade_card",
  "__get_program_id",
  "get_grade_card",
  "__get_semester_number",
  "get_sgpa_cgpa",
  "get_hostel_details",
  "get_fines_msc_charges",
  "get_fee_summary",
  "get_subject_choices"
];

Any attempt to call these methods without first calling student_login() will throw a NotLoggedIn exception.

Sources: src/wrapper.js692-719

Method Endpoint Mapping

The following table maps WebPortal methods to their corresponding API endpoints for reference:

Sources: src/wrapper.js168-670

Usage Pattern

The typical usage pattern for the jsjiit API follows this sequence:

1. Import the library

   import { WebPortal } from 'jsjiit';

2. Create a WebPortal instance

   const portal = new WebPortal();

3. Authenticate

   await portal.student_login(username, password);

4. Call API methods

   const meta = await portal.get_attendance_meta(); const grades = await portal.get_grade_card(semester);

All authenticated methods return Promises and should be awaited. Errors should be caught and handled appropriately using try-catch blocks.

For complete usage examples, see Quick Start Guide.

Sources: README.md21-96 src/wrapper.js75-81

Version and Compatibility

The current API version is 0.0.23 as defined in package.json. The library targets ES2020+ browsers and is distributed as ES modules.

Import Paths

• NPM: import { WebPortal } from 'jsjiit'
• CDN (Production): import { WebPortal } from 'https://cdn.jsdelivr.net/npm/jsjiit@0.0.23/dist/jsjiit.min.esm.js'
• CDN (Development): import { WebPortal } from 'https://cdn.jsdelivr.net/npm/jsjiit@0.0.23/dist/jsjiit.esm.js'

For installation instructions, see Installation.

Sources: README.md23-28 package.json