WebUntis

https://webuntis.noim.me/
Admin
WebUntis is a Node.js wrapper for the JSON RPC WebUntis API that provides multiple authentication...
Tokens:7,157
Snippets:90
Trust Score:5.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install WebUntis Package

Source: https://webuntis.noim.me/

Commands to install the package using common Node.js package managers.

```bash
yarn add webuntis  
# Or  
npm i webuntis --save  
# Or  
pnpm i webuntis
```

--------------------------------

### getHomeWorksFor

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get homework for a specific range.

```APIDOC
## getHomeWorksFor(rangeStart, rangeEnd, validateSession?)

### Description
Get homework for a specific range.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<Homework[]>**
```

--------------------------------

### getDepartments

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get all departments known by WebUntis.

```APIDOC
## getDepartments(validateSession?)

### Description
Get all departments known by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<Department[]>**
```

--------------------------------

### getClasses

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get all classes known by WebUntis.

```APIDOC
## getClasses(validateSession?, schoolyearId)

### Description
Get all classes known by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional - Default: true
- **schoolyearId** (number) - Required

### Returns
- **Promise<Klasse[]>**
```

--------------------------------

### getInbox

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get Inbox.

```APIDOC
## getInbox(validateSession?)

### Description
Get Inbox.

### Parameters
- **validateSession** (boolean) - Required - Default: true

### Returns
- **Promise<Inbox>**
```

--------------------------------

### getExamsForRange

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get Exams for range.

```APIDOC
## getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?)

### Description
Get Exams for range.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **klasseId** (number) - Required - Default: -1
- **withGrades** (boolean) - Required - Default: false
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<Exam[]>**
```

--------------------------------

### getNewsWidget

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get News Widget.

```APIDOC
## getNewsWidget(date, validateSession?)

### Description
Get News Widget.

### Parameters
- **date** (Date) - Required
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<NewsWidget>**
```

--------------------------------

### getHolidays

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get all holidays known by WebUntis.

```APIDOC
## getHolidays(validateSession?)

### Description
Get all holidays known by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<Holiday[]>**
```

--------------------------------

### getLatestSchoolyear

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get the latest WebUntis Schoolyear.

```APIDOC
## getLatestSchoolyear(validateSession?)

### Description
Get the latest WebUntis Schoolyear.

### Parameters
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<SchoolYear>**
```

--------------------------------

### getCurrentSchoolyear

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get the current school year.

```APIDOC
## getCurrentSchoolyear(validateSession?)

### Description
Get the current school year.

### Parameters
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<SchoolYear>**
```

--------------------------------

### getLatestImportTime

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Get the time when WebUntis last changed its data.

```APIDOC
## getLatestImportTime(validateSession?)

### Description
Get the time when WebUntis last changed its data.

### Parameters
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<number>**
```

--------------------------------

### constructor

Source: https://webuntis.noim.me/classes/WebUntisAnonymousAuth.html

Initializes a new instance of the WebUntisAnonymousAuth class.

```APIDOC
## constructor

### Description
Creates a new instance of the WebUntisAnonymousAuth class to interact with the WebUntis API.

### Signature
new WebUntisAnonymousAuth(school: string, baseurl: string, identity?: string, disableUserAgent?: boolean)

### Parameters
- **school** (string) - Required - The name of the school.
- **baseurl** (string) - Required - The base URL of the WebUntis API.
- **identity** (string) - Optional - The identity string (default: 'Awesome').
- **disableUserAgent** (boolean) - Optional - If true, axios will not send a custom User-Agent (default: false).
```

--------------------------------

### new WebUntis(school, username, password, baseurl, identity?, disableUserAgent?)

Source: https://webuntis.noim.me/classes/WebUntis.html

Initializes a new instance of the WebUntis client to interact with the WebUntis API.

```APIDOC
## Constructor: new WebUntis

### Description
Initializes a new instance of the WebUntis client. This is required to authenticate and interact with the WebUntis service.

### Parameters
- **school** (string) - Required - The school identifier.
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.
- **baseurl** (string) - Required - The host name of your WebUntis instance (e.g., mese.webuntis.com).
- **identity** (string) - Optional - An identity string for the application (default: 'Awesome').
- **disableUserAgent** (boolean) - Optional - If true, prevents axios from sending a custom User-Agent (default: false).
```

--------------------------------

### new WebUntisQR(QRCodeURI, identity?, authenticator, URL?, disableUserAgent?)

Source: https://webuntis.noim.me/classes/WebUntisQR.html

Initializes a new instance of the WebUntisQR class using data obtained from a WebUntis QR code.

```APIDOC
## Constructor: new WebUntisQR(QRCodeURI, identity?, authenticator, URL?, disableUserAgent?)

### Description
Initializes a new WebUntisQR instance using the URI data obtained from a WebUntis QR code (found under profile -> Data access -> Display).

### Parameters
- **QRCodeURI** (string) - Required - The URI string from the WebUntis QR code.
- **identity** (string) - Optional - A custom identity string (e.g., 'MyAwesomeApp').
- **authenticator** (Authenticator<AuthenticatorOptions<string>>) - Required - A custom otplib v12 instance.
- **URL** (typeof URL) - Optional - A custom whatwg url implementation.
- **disableUserAgent** (boolean) - Optional - If true, prevents axios from sending a custom User-Agent. Defaults to false.

### Returns
- **WebUntisQR** - An instance of the WebUntisQR class.
```

--------------------------------

### Authenticate with User and Password

Source: https://webuntis.noim.me/

Standard authentication method using school credentials and server URL.

```javascript
import { WebUntis } from 'webuntis';  
  
const untis = new WebUntis('school', 'username', 'password', 'xyz.webuntis.com');  
  
await untis.login();  
const timetable = await untis.getOwnTimetableForToday();  
  
// profit
```

--------------------------------

### login

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Authenticates the user with provided credentials.

```APIDOC
## login()

### Description
Login with your credentials. Note: The server may revoke this session after less than 10 minutes of idle.

### Returns
- **Promise<SessionInformation>** - A promise that resolves to session information.
```

--------------------------------

### new WebUntisSecretAuth(school, user, secret, baseurl, identity?, authenticator, disableUserAgent?)

Source: https://webuntis.noim.me/classes/WebUntisSecretAuth.html

Initializes a new instance of the WebUntisSecretAuth class to handle authentication and API requests.

```APIDOC
## Constructor: new WebUntisSecretAuth

### Description
Initializes a new instance of the WebUntisSecretAuth class. This constructor sets up the necessary credentials and configuration to interact with the WebUntis API.

### Parameters
- **school** (string) - Required - The school identifier.
- **user** (string) - Required - The username for authentication.
- **secret** (string) - Required - The secret key for authentication.
- **baseurl** (string) - Required - The host name of your WebUntis instance (e.g., mese.webuntis.com).
- **identity** (string) - Optional - A custom identity string (default: 'Awesome').
- **authenticator** (Authenticator) - Required - Custom otplib v12 instance.
- **disableUserAgent** (boolean) - Optional - If true, axios will not send a custom User-Agent (default: false).
```

--------------------------------

### Define Lesson Interface

Source: https://webuntis.noim.me/interfaces/Lesson.html

Represents the full structure of a lesson, including optional fields for remarks and status flags.

```typescript
interface Lesson {   
activityType?: string;   
bkRemark?: string;   
bkText?: string;   
code?: "cancelled" | "irregular";   
date: number;   
endTime: number;   
id: number;   
info?: string;   
kl: ShortData[];   
lsnumber: number;   
lstext?: string;   
ro: ShortData[];   
sg?: string;   
startTime: number;   
statflags?: string;   
su: ShortData[];   
substText?: string;   
te: ShortData[];   
}
```

--------------------------------

### getPdfOfAbsentLesson

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Generates a URL to a PDF report of absent lessons.

```APIDOC
## getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?)

### Description
Returns a URL to a unique PDF of all the lessons you were absent.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **validateSession** (boolean) - Optional
- **excuseStatusId** (number) - Optional (Default: -1)
- **lateness** (boolean) - Optional (Default: true)
- **absences** (boolean) - Optional (Default: true)
- **excuseGroup** (number) - Optional (Default: 2)
```

--------------------------------

### Authenticate with QR Code

Source: https://webuntis.noim.me/

Uses scanned QR code data along with an authenticator and URL module for login.

```javascript
import { WebUntisQR } from 'webuntis';  
import { URL } from 'url';  
import { authenticator as Authenticator } from 'otplib';  
  
// The result of the scanned QR Code  
const QRCodeData = 'untis://setschool?url=[...]&school=[...]&user=[...]&key=[...]&schoolNumber=[...]';  
  
const untis = new WebUntisQR(QRCodeData, 'custom-identity', Authenticator, URL);  
  
await untis.login();  
const timetable = await untis.getOwnTimetableForToday();  
  
// profit
```

--------------------------------

### getTimegrid

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timegrid for the current school.

```APIDOC
## getTimegrid(validateSession?)

### Description
Get the timegrid of current school.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getHomeWorkAndLessons

Source: https://webuntis.noim.me/classes/WebUntis.html

Retrieve homework and lessons for a specific range.

```APIDOC
## getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?)

### Description
Retrieve homework and lessons for a specific range.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **validateSession** (boolean) - Optional - Default: true

### Returns
- Promise<any[]>
```

--------------------------------

### getOwnTimetableFor

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the user's personal timetable for a specific day.

```APIDOC
## getOwnTimetableFor(date, validateSession?)

### Description
Get your own Timetable for the given day. Note: You can't use this with anonymous login.

### Parameters
- **date** (Date) - Required
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getAbsentLesson

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Returns all the Lessons where you were absent including the excused one.

```APIDOC
## getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?)

### Description
Returns all the Lessons where you were absent including the excused one.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **excuseStatusId** (number) - Optional - Default: -1
- **validateSession** (boolean) - Optional - Default: true

### Returns
- **Promise<Absences>**
```

--------------------------------

### getRooms

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves a list of all rooms known by WebUntis.

```APIDOC
## getRooms(validateSession?)

### Description
Get all known rooms by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getOwnTimetableForToday

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the user's personal timetable for the current day.

```APIDOC
## getOwnTimetableForToday(validateSession?)

### Description
Get your own Timetable for the current day. Note: You can't use this with anonymous login.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getStudents

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves a list of all students.

```APIDOC
## getStudents(validateSession?)

### Description
Get all known students by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### Lesson Property Definitions

Source: https://webuntis.noim.me/interfaces/Lesson.html

Individual property definitions for the Lesson interface.

```typescript
activityType?: string
```

```typescript
bkRemark?: string
```

```typescript
bkText?: string
```

```typescript
code?: "cancelled" | "irregular"
```

```typescript
date: number
```

```typescript
endTime: number
```

```typescript
id: number
```

```typescript
info?: string
```

```typescript
kl: ShortData[]
```

```typescript
lsnumber: number
```

```typescript
lstext?: string
```

```typescript
ro: ShortData[]
```

```typescript
sg?: string
```

```typescript
startTime: number
```

```typescript
statflags?: string
```

```typescript
su: ShortData[]
```

```typescript
substText?: string
```

```typescript
te: ShortData[]
```

--------------------------------

### Define Student Interface

Source: https://webuntis.noim.me/interfaces/Student.html

The structure of the Student interface including all required properties.

```typescript
interface Student {   
foreName: string;   
gender: string;   
id: number;   
key: number;   
longName: string;   
name: string;   
}
```

--------------------------------

### getSubjects

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves a list of subjects for the current user.

```APIDOC
## getSubjects(validateSession?)

### Description
Get all known Subjects for the current logged-in user.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### Define backColor property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Optional string representing the background color.

```typescript
backColor?: string
```

--------------------------------

### getOwnClassTimetableForToday

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for the user's class for the current day.

```APIDOC
## getOwnClassTimetableForToday(validateSession?)

### Description
Get the Timetable of your class for today. Note: You can't use this with anonymous login.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### Authenticate with User and Secret

Source: https://webuntis.noim.me/

Uses a shared secret and authenticator for secure login.

```javascript
import { WebUntisSecretAuth } from 'webuntis';  
import { authenticator as Authenticator } from 'otplib';  
  
const secret = 'NL04FGY4FSY5';  
  
const untis = new WebUntisSecretAuth('school', 'username', secret, 'xyz.webuntis.com', 'custom-identity', Authenticator);  
  
await untis.login();  
const timetable = await untis.getOwnTimetableForToday();  
  
// profit
```

--------------------------------

### Define name property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Short name or label for the class.

```typescript
name: string
```

--------------------------------

### Student Property Definitions

Source: https://webuntis.noim.me/interfaces/Student.html

Individual property definitions for the Student interface.

```typescript
foreName: string
```

```typescript
gender: string
```

```typescript
id: number
```

```typescript
key: number
```

```typescript
longName: string
```

```typescript
name: string
```

--------------------------------

### Room property definitions

Source: https://webuntis.noim.me/interfaces/Room.html

Individual property definitions for the Room interface.

```typescript
active: boolean
```

```typescript
alternateName: string
```

```typescript
backColor: string
```

```typescript
foreColor: string
```

```typescript
id: number
```

```typescript
longName: string
```

```typescript
name: string
```

--------------------------------

### Define foreColor property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Optional string representing the foreground color.

```typescript
foreColor?: string
```

--------------------------------

### getTeachers

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves a list of all teachers.

```APIDOC
## getTeachers(validateSession?)

### Description
Get all known teachers by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getOwnTimetableForRange

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the user's personal timetable for a specified date range.

```APIDOC
## getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?)

### Description
Get your own timetable for a given Date range. Note: You can't use this with anonymous login.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### Define lessonId property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the identifier for the associated lesson.

```typescript
lessonId: number
```

--------------------------------

### logout

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Terminates the current WebUntis session.

```APIDOC
## logout()

### Description
Logout the current session.

### Returns
- **Promise<boolean>** - A promise that resolves to true if logout was successful.
```

--------------------------------

### getOwnTimetableForWeek

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for the current week for the current element.

```APIDOC
## getOwnTimetableForWeek(date, formatId?, validateSession?)

### Description
Get the timetable for the current week for the current element from the web client API.

### Parameters
- **date** (Date) - Required (one date in the week to query)
- **formatId** (number) - Optional (Default: 1, set to 1 to include teachers, 2 omits the teachers)
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getTimetableFor

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for a specific element on a specific day.

```APIDOC
## getTimetableFor(date, id, type, validateSession?)

### Description
Get the timetable for a specific day for a specific element.

### Parameters
- **date** (Date) - Required
- **id** (number) - Required
- **type** (number) - Required
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getOwnClassTimetableFor

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for the user's class for a specific day. Note: This method requires an authenticated session and cannot be used with anonymous login.

```APIDOC
## getOwnClassTimetableFor(date, validateSession?)

### Description
Get the Timetable of your class for the given day. Note: You can't use this with anonymous login.

### Parameters
- **date** (Date) - Required
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getSchoolyears

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves a list of all school years.

```APIDOC
## getSchoolyears(validateSession?)

### Description
Get all WebUntis Schoolyears.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getStatusData

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves status data from WebUntis.

```APIDOC
## getStatusData(validateSession?)

### Description
Get all status data known by WebUntis.

### Parameters
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### Define type property

Source: https://webuntis.noim.me/interfaces/WebElementData.html

Specifies the type of the web element.

```typescript
type: WebUntisElementType
```

--------------------------------

### Define Room interface

Source: https://webuntis.noim.me/interfaces/Room.html

Represents the structure of a room entity with its associated metadata and display properties.

```typescript
interface Room {   
active: boolean;   
alternateName: string;   
backColor: string;   
foreColor: string;   
id: number;   
longName: string;   
name: string;   
}
```

--------------------------------

### getOwnClassTimetableForRange

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for the user's class for a specified date range.

```APIDOC
## getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?)

### Description
Get the Timetable of your class for a given Date range. Note: You can't use this with anonymous login.

### Parameters
- **rangeStart** (Date) - Required
- **rangeEnd** (Date) - Required
- **validateSession** (boolean) - Optional (Default: true)
```

--------------------------------

### getTimetableForToday

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for the current day for a specific element.

```APIDOC
## getTimetableForToday(id, type, validateSession?)

### Description
Get the timetable of today for a specific element.

### Parameters
- **id** (number) - Required - Element ID.
- **type** (number) - Required - Element type.
- **validateSession** (boolean) - Optional - Whether to validate the session (default: true).

### Returns
- **Promise<Lesson[]>** - A promise that resolves to an array of lessons.
```

--------------------------------

### Define Homework interface

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the structure of a homework assignment within the system.

```typescript
interface Homework {   
attachments: any[];   
completed: boolean;   
date: number;   
dueDate: number;   
id: number;   
lessonId: number;   
remark: string;   
text: string;   
}
```

--------------------------------

### Define date property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the date of the homework.

```typescript
date: number
```

--------------------------------

### Define WebElementData interface

Source: https://webuntis.noim.me/interfaces/WebElementData.html

Represents the core structure for web element data objects.

```typescript
interface WebElementData {   
element: {   
alternatename?: string;   
canViewTimetable: boolean;   
displayname?: string;   
externalKey?: string;   
id: number;   
longName?: string;   
name: string;   
roomCapacity: number;   
type: number;   
};   
id: number;   
missing: boolean;   
orgId: number;   
state: "REGULAR" | "ABSENT" | "SUBSTITUTED";   
type: WebUntisElementType;   
}
```

--------------------------------

### Define completed property

Source: https://webuntis.noim.me/interfaces/Homework.html

Indicates whether the homework is completed.

```typescript
completed: boolean
```

--------------------------------

### Define Exam Primitive Properties

Source: https://webuntis.noim.me/interfaces/Exam.html

Individual property definitions for the Exam interface.

```typescript
endTime: number
```

```typescript
examDate: number
```

```typescript
examType: string
```

```typescript
grade?: string
```

```typescript
id: number
```

```typescript
name: string
```

```typescript
rooms: string[]
```

```typescript
startTime: number
```

```typescript
studentClass: string[]
```

```typescript
subject: string
```

```typescript
teachers: string[]
```

```typescript
text: string
```

--------------------------------

### getTimetableFor

Source: https://webuntis.noim.me/classes/WebUntis.html

Retrieves the timetable for a specific element.

```APIDOC
## getTimetableFor(date, id, type, validateSession?)

### Description
Get the timetable for a specific day for a specific element.

### Parameters
- **date** (Date) - Required
- **id** (number) - Required
- **type** (number) - Required
- **validateSession** (boolean) - Optional - Default: true
```

--------------------------------

### Define text property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the text content of the homework.

```typescript
text: string
```

--------------------------------

### Authenticate Anonymously

Source: https://webuntis.noim.me/

Access public school data without credentials, if supported by the school.

```javascript
import { WebUntisAnonymousAuth, WebUntisElementType } from 'webuntis';  
  
const untis = new WebUntisAnonymousAuth('school', 'xyz.webuntis.com');  
  
await untis.login();  
const classes = await untis.getClasses();  
const timetable = await untis.getTimetableForToday(classes[0].id, WebUntisElementType.CLASS);  
  
// profit
```

--------------------------------

### Define dueDate property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the due date of the homework.

```typescript
dueDate: number
```

--------------------------------

### Define Subject Interface

Source: https://webuntis.noim.me/interfaces/Subject.html

Represents the structure of a subject entity within the system.

```typescript
interface Subject {   
active: boolean;   
alternateName: string;   
backColor: string;   
foreColor: string;   
id: number;   
longName: string;   
name: string;   
}
```

--------------------------------

### convertUntisDate

Source: https://webuntis.noim.me/classes/WebUntisSecretAuth.html

Converts a WebUntis date string to a JS Date object.

```APIDOC
## convertUntisDate(date, baseDate?)

### Description
Converts the untis date string format to a normal JS Date object.

### Parameters
- **date** (string) - Required - Untis date string
- **baseDate** (Date) - Optional - Base date. Default beginning of current day

### Returns
- **Date**
```

--------------------------------

### convertUntisTime

Source: https://webuntis.noim.me/classes/WebUntisSecretAuth.html

Converts a WebUntis time string to a JS Date object.

```APIDOC
## convertUntisTime(time, baseDate?)

### Description
Convert a untis time string to a JS Date object.

### Parameters
- **time** (string | number) - Required - Untis time string
- **baseDate** (Date) - Optional - Day used as base for the time. Default: Current date

### Returns
- **Date**
```

--------------------------------

### convertDateToUntis

Source: https://webuntis.noim.me/classes/WebUntisSecretAuth.html

Converts a JS Date object to a WebUntis date string.

```APIDOC
## convertDateToUntis(date)

### Description
Convert a JS Date Object to a WebUntis date string.

### Parameters
- **date** (Date) - Required

### Returns
- **string**
```

--------------------------------

### Define did property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Optional numeric identifier for the department or division.

```typescript
did?: number
```

--------------------------------

### validateSession

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Checks if the current session is still valid.

```APIDOC
## validateSession()

### Description
Checks if your current WebUntis Session is valid.

### Returns
- **Promise<boolean>** - A promise that resolves to true if the session is valid.
```

--------------------------------

### Define Exam Interface

Source: https://webuntis.noim.me/interfaces/Exam.html

Represents the full structure of an exam object.

```typescript
interface Exam {   
assignedStudents: {   
displayName: string;   
id: number;   
klasse: {   
id: number;   
name: string;   
};   
}[];   
endTime: number;   
examDate: number;   
examType: string;   
grade?: string;   
id: number;   
name: string;   
rooms: string[];   
startTime: number;   
studentClass: string[];   
subject: string;   
teachers: string[];   
text: string;   
}
```

--------------------------------

### getTimetableForWeek

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for the current week for a specific element.

```APIDOC
## getTimetableForWeek(date, id, type, formatId?, validateSession?)

### Description
Get the timetable for the current week for a specific element from the web client API.

### Parameters
- **date** (Date) - Required - One date in the week to query.
- **id** (number) - Required - Element ID.
- **type** (number) - Required - Element type.
- **formatId** (number) - Optional - Set to 1 to include teachers, 2 omits teachers (default: 1).
- **validateSession** (boolean) - Optional - Whether to validate the session (default: true).

### Returns
- **Promise<WebAPITimetable[]>** - A promise that resolves to an array of timetable entries.
```

--------------------------------

### Define missing property

Source: https://webuntis.noim.me/interfaces/WebElementData.html

Indicates whether the element data is missing.

```typescript
missing: boolean
```

--------------------------------

### getTimetableForRange

Source: https://webuntis.noim.me/classes/InternalWebuntisSecretLogin.html

Retrieves the timetable for a specific element within a defined date range.

```APIDOC
## getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?)

### Description
Get the timetable for a given Date range for a specific element.

### Parameters
- **rangeStart** (Date) - Required - Start date of the range.
- **rangeEnd** (Date) - Required - End date of the range.
- **id** (number) - Required - Element ID.
- **type** (number) - Required - Element type.
- **validateSession** (boolean) - Optional - Whether to validate the session (default: true).

### Returns
- **Promise<Lesson[]>** - A promise that resolves to an array of lessons.
```

--------------------------------

### Define state property

Source: https://webuntis.noim.me/interfaces/WebElementData.html

Specifies the current state of the element.

```typescript
state: "REGULAR" | "ABSENT" | "SUBSTITUTED"
```

--------------------------------

### Define longName property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Full descriptive name of the class.

```typescript
longName: string
```

--------------------------------

### Define attachments property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the attachments associated with the homework.

```typescript
attachments: any[]
```

--------------------------------

### Define teacher1 property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Optional numeric identifier for the primary teacher.

```typescript
teacher1?: number
```

--------------------------------

### Define Klasse interface

Source: https://webuntis.noim.me/interfaces/Klasse.html

Represents the structure of a class entity within the system.

```typescript
interface Klasse {   
active: boolean;   
backColor?: string;   
did?: number;   
foreColor?: string;   
id: number;   
longName: string;   
name: string;   
teacher1?: number;   
teacher2?: number;   
}
```

--------------------------------

### Define teacher2 property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Optional numeric identifier for the secondary teacher.

```typescript
teacher2?: number
```

--------------------------------

### Define active property

Source: https://webuntis.noim.me/interfaces/Klasse.html

Boolean flag indicating if the class is currently active.

```typescript
active: boolean
```

--------------------------------

### Define remark property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents any remarks associated with the homework.

```typescript
remark: string
```

--------------------------------

### Define orgId property

Source: https://webuntis.noim.me/interfaces/WebElementData.html

Represents the organization identifier.

```typescript
orgId: number
```

--------------------------------

### Define id property

Source: https://webuntis.noim.me/interfaces/Homework.html

Represents the unique identifier for the homework.

```typescript
id: number
```

--------------------------------

### getTimetableForWeek

Source: https://webuntis.noim.me/classes/WebUntisAnonymousAuth.html

Retrieves the timetable for the week containing the specified date for a specific element.

```APIDOC
## getTimetableForWeek(date, id, type, formatId?, validateSession?)

### Description
Get the timetable for the current week for a specific element from the web client API.

### Parameters
- **date** (Date) - Required - One date in the week to query
- **id** (number) - Required - Element id
- **type** (number) - Required - Element type
- **formatId** (number) - Optional - Default: 1 - Set to 1 to include teachers, 2 omits the teachers in elements response
- **validateSession** (boolean) - Optional - Default: true

### Returns
- Promise<WebAPITimetable[]>
```

--------------------------------

### Define element property structure

Source: https://webuntis.noim.me/interfaces/WebElementData.html

Details the nested structure of the element property within WebElementData.

```typescript
element: {   
alternatename?: string;   
canViewTimetable: boolean;   
displayname?: string;   
externalKey?: string;   
id: number;   
longName?: string;   
name: string;   
roomCapacity: number;   
type: number;   
}
```

--------------------------------

### Define assignedStudents Property

Source: https://webuntis.noim.me/interfaces/Exam.html

Structure for the assignedStudents array within an Exam.

```typescript
assignedStudents: {   
displayName: string;   
id: number;   
klasse: {   
id: number;   
name: string;   
};   
}[]
```

--------------------------------

### Absences Property Definitions

Source: https://webuntis.noim.me/interfaces/Absences.html

Individual property definitions for the Absences interface.

```typescript
absenceReasons: []
```

```typescript
absences: Absence[]
```

```typescript
excuseStatuses: boolean
```

```typescript
showAbsenceReasonChange: boolean
```

```typescript
showCreateAbsence: boolean
```

--------------------------------

### Absences Interface Definition

Source: https://webuntis.noim.me/interfaces/Absences.html

Defines the shape of the Absences object used for managing absence data.

```typescript
interface Absences {   
absenceReasons: [];   
absences: Absence[];   
excuseStatuses: boolean;   
showAbsenceReasonChange: boolean;   
showCreateAbsence: boolean;   
}
```
Tokens:
Raw