Data Models

This document provides an overview of all data model classes in pyjiit. These classes provide structured, type-safe access to raw JSON responses from the JIIT Webportal API. Each model represents a specific domain entity (attendance, exams, registrations, or authentication tokens) and encapsulates the deserialization logic for API responses.

For detailed documentation of specific model groups, see:

• Attendance-related models: 3.3.1
• Exam-related models: 3.3.2
• Registration-related models: 3.3.3
• Token and captcha models: 3.3.4

For information about the Webportal class that returns these models, see 3.1.

Data Model Architecture

All data models in pyjiit follow a consistent architectural pattern. They serve as intermediaries between raw JSON API responses and Python application code, providing attribute-based access and type safety.

Sources: pyjiit/wrapper.py1-489 pyjiit/attendance.py1-53 pyjiit/exam.py1-24 pyjiit/registration.py1-44 pyjiit/tokens.py1-29

Model Categories

The library contains four distinct categories of data models, each serving a specific domain within the JIIT Webportal system:

Sources: pyjiit/attendance.py1-53 pyjiit/exam.py1-24 pyjiit/registration.py1-44 pyjiit/tokens.py1-29

Model Class Structure

Sources: pyjiit/attendance.py4-51 pyjiit/exam.py4-21 pyjiit/registration.py4-42 pyjiit/tokens.py4-28

Common Design Patterns

All data models in pyjiit implement consistent patterns that simplify their usage and maintenance:

Dataclass Decoration

Most models use Python's @dataclass decorator for automatic initialization and representation methods:

Sources: pyjiit/attendance.py3-36 pyjiit/exam.py3-21 pyjiit/registration.py3-32 pyjiit/tokens.py3-28

Static Factory Methods

All models provide from_json() static methods that construct instances from dictionary responses:

Sources: pyjiit/attendance.py13-36 pyjiit/exam.py12-20 pyjiit/registration.py18-32 pyjiit/tokens.py21-27

Container Models

Two models (AttendanceMeta and Registrations) serve as containers that aggregate multiple child objects and provide convenience methods:

• AttendanceMeta (pyjiit/attendance.py40-51):

  • Contains lists of AttendanceHeader and Semester objects
  • Provides latest_header() and latest_semester() convenience methods
  • Stores raw_response for direct access to original data

• Registrations (pyjiit/registration.py36-42):

  • Contains list of RegisteredSubject objects
  • Provides total_credits summary field
  • Stores raw_response for direct access to original data

Sources: pyjiit/attendance.py40-51 pyjiit/registration.py36-42

Model Usage in Webportal Methods

The Webportal class methods return data model instances to provide structured access to API responses. The following table maps each method to its return type:

Sources: pyjiit/wrapper.py145-383

Model Instantiation Flow

Sources: pyjiit/wrapper.py173-188 pyjiit/attendance.py40-51 pyjiit/attendance.py13-20 pyjiit/attendance.py32-36

Shared Model: Semester

The Semester class is unique in that it's used across multiple domains (attendance, exams, registrations, marks, grade cards). This model represents a semester registration period and contains two key identifiers:

Methods that require semester-specific operations accept Semester objects as parameters:

• get_attendance() (pyjiit/wrapper.py191-211)
• get_registered_subjects_and_faculties() (pyjiit/wrapper.py252-269)
• get_exam_events() (pyjiit/wrapper.py292-308)
• download_marks() (pyjiit/wrapper.py349-367)
• get_grade_card() (pyjiit/wrapper.py403-421)

Sources: pyjiit/attendance.py24-36 pyjiit/wrapper.py191-421

Raw Response Preservation

Models that aggregate complex data preserve the original API response in a raw_response attribute. This allows users to access fields not explicitly mapped to model attributes:

• AttendanceMeta.raw_response (pyjiit/attendance.py42):

  • Full response from /StudentClassAttendance/getstudentInforegistrationforattendence

• Registrations.raw_response (pyjiit/registration.py39):

  • Full response from /reqsubfaculty/getfaculties

• WebportalSession.raw_response (pyjiit/wrapper.py43):

  • Full token generation response (not technically a data model, but follows same pattern)

Sources: pyjiit/attendance.py40-43 pyjiit/registration.py36-39 pyjiit/wrapper.py38-43