Registration Models

This page documents the data model classes used to represent student course registration information in pyjiit. These models structure the responses from registration-related API endpoints into typed Python objects.

For information about session management and authentication, see 3.2. For attendance-related models, see 3.3.1. For exam-related models, see 3.3.2.

Overview

The registration module provides two primary classes for handling course registration data:

These models are used by the Webportal.get_registered_subjects_and_faculties() method to structure API responses from the /reqsubfaculty/getfaculties endpoint.

Sources: pyjiit/registration.py1-44 pyjiit/wrapper.py5 pyjiit/wrapper.py252-269

RegisteredSubject Dataclass

The RegisteredSubject dataclass encapsulates all information about a single registered subject for a student.

Structure

Field Descriptions

Factory Method

The from_json() static method constructs a RegisteredSubject instance from the raw API response dictionary. It maps API field names (lowercase with no underscores) to Python attribute names (lowercase with underscores).

Example API-to-Object mapping:

• "employeename" → employee_name
• "subjectcode" → subject_code
• "subjectcomponentcode" → subject_component_code

Sources: pyjiit/registration.py4-32

Registrations Container Class

The Registrations class aggregates all registered subjects for a given semester and provides the total credit count.

Structure

Attributes

Initialization

The constructor accepts the raw API response dictionary and:

1. Stores the complete response in raw_response
2. Extracts totalcreditpoints as total_credits
3. Transforms the registrations array into a list of RegisteredSubject objects using RegisteredSubject.from_json()

Sources: pyjiit/registration.py36-43

Usage in Webportal API

The registration models are used in the following workflow within the Webportal class:

Method: get_registered_semesters()

This method retrieves the list of semesters for which the student has registered subjects. It returns a list of Semester objects (defined in the attendance module).

Endpoint: /reqsubfaculty/getregistrationList

Implementation: pyjiit/wrapper.py233-249

Method: get_registered_subjects_and_faculties()

This method retrieves all registered subjects and their assigned faculty for a specific semester.

Parameters:

• semester: A Semester object (typically obtained from get_registered_semesters())

Returns: Registrations object containing all subject registrations

Endpoint: /reqsubfaculty/getfaculties

Implementation: pyjiit/wrapper.py252-269

Sources: pyjiit/wrapper.py233-269 docs/usage.rst111-137

Data Flow: API Response to Model Objects

The following diagram illustrates how raw API data is transformed into typed model objects:

Sources: pyjiit/registration.py18-32 pyjiit/registration.py38-41

Typical Usage Pattern

The following example demonstrates the standard workflow for retrieving and working with registration data:

Code Example from Documentation:

# Assumes w = Webportal() and login completed

# Step 1: Get list of registered semesters
semesters = w.get_registered_semesters()
sem = semesters[0]  # Select a semester (latest in this case)

# Step 2: Get all registered subjects for the semester
reg = w.get_registered_subjects_and_faculties(sem)

# Step 3: Access individual subjects
for subject in reg.subjects:
    print(f"Subject: {subject.subject_desc}")
    print(f"Faculty: {subject.employee_name}")
    print(f"Credits: {subject.credits}")

# Step 4: Access total credits
print(f"Total credits: {reg.total_credits}")

Expected Output Structure:

RegisteredSubject(
    employee_name='Teacher name',
    employee_code='SomeCode',
    minor_subject='N',
    remarks='REG',
    stytype='REG',
    credits=4.0,
    subject_code='15B11CI111',
    subject_component_code='T',
    subject_desc='SOFTWARE DEVELOPMENT FUNDAMENTALS-1',
    subject_id='150046',
    audtsubject='N'
)

Sources: docs/usage.rst111-137

Relationship to Other Models

The Semester class (defined in pyjiit/attendance.py) is shared between attendance and registration functionalities. The same Semester objects returned by get_registered_semesters() can be used with:

• get_registered_subjects_and_faculties() (registration data)
• get_attendance() (attendance data)
• get_exam_events() (exam data)

Sources: pyjiit/wrapper.py233-269 pyjiit/attendance.py13-28

Implementation Details

Dataclass vs Regular Class

The RegisteredSubject uses Python's @dataclass decorator, which automatically generates:

• __init__() method
• __repr__() method for readable string representation
• __eq__() method for equality comparison

The Registrations class uses a traditional class definition because it requires custom initialization logic to transform the raw API response.

API Field Mapping

The API uses lowercase field names without underscores (e.g., employeename, subjectcode), while the Python models use snake_case for PEP 8 compliance (e.g., employee_name, subject_code). The from_json() method handles this translation.

Sources: pyjiit/registration.py1-44