Class WebUntis

constructor

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

• Parameters

  • school: string

    The school identifier

  • username: string

  • password: string

  • baseurl: string

    Just the host name of your WebUntis (Example: mese.webuntis.com)

  • Optional identity: string = 'Awesome'

    A identity like: MyAwesomeApp

  • Optional disableUserAgent: boolean = false

    If this is true, axios will not send a custom User-Agent

  Returns WebUntis

anonymous

axios

baseurl

cookies

id

password

school

schoolbase64

sessionInformation

username

Static TYPES

getAbsentLesson

• getAbsentLesson(rangeStart, rangeEnd, excuseStatusId?, validateSession?): Promise<Absences>

• Returns all the Lessons where you were absent including the excused one!

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • Optional excuseStatusId: number = -1

  • Optional validateSession: boolean = true

  Returns Promise<Absences>

getClasses

• getClasses(validateSession?, schoolyearId): Promise<Klasse[]>

• Get all classes known by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  • schoolyearId: number

  Returns Promise<Klasse[]>

getCurrentSchoolyear

• getCurrentSchoolyear(validateSession?): Promise<SchoolYear>

• Get the current school year

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<SchoolYear>

getDepartments

• getDepartments(validateSession?): Promise<Department[]>

• Get all departments known by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Department[]>

getExamsForRange

• getExamsForRange(rangeStart, rangeEnd, klasseId?, withGrades?, validateSession?): Promise<Exam[]>

• Get Exams for range

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • klasseId: number = -1

  • withGrades: boolean = false

  • Optional validateSession: boolean = true

  Returns Promise<Exam[]>

getHolidays

• getHolidays(validateSession?): Promise<Holiday[]>

• Get all holidays known by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Holiday[]>

getHomeWorkAndLessons

• getHomeWorkAndLessons(rangeStart, rangeEnd, validateSession?): Promise<any[]>

• TODO: Find out what type this function returns

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • Optional validateSession: boolean = true

  Returns Promise<any[]>

getHomeWorksFor

• getHomeWorksFor(rangeStart, rangeEnd, validateSession?): Promise<Homework[]>

• Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • Optional validateSession: boolean = true

  Returns Promise<Homework[]>

getInbox

• getInbox(validateSession?): Promise<Inbox>

• Get Inbox

  Parameters

  • validateSession: boolean = true

  Returns Promise<Inbox>

getLatestImportTime

• getLatestImportTime(validateSession?): Promise<number>

• Get the time when WebUntis last changed its data

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<number>

getLatestSchoolyear

• getLatestSchoolyear(validateSession?): Promise<SchoolYear>

• Get the latest WebUntis Schoolyear

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<SchoolYear>

getNewsWidget

• getNewsWidget(date, validateSession?): Promise<NewsWidget>

• Get News Widget

  Parameters

  • date: Date

  • Optional validateSession: boolean = true

  Returns Promise<NewsWidget>

  see index.d.ts NewsWidget

getOwnClassTimetableFor

• getOwnClassTimetableFor(date, validateSession?): Promise<Lesson[]>

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

  Parameters

  • date: Date

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getOwnClassTimetableForRange

• getOwnClassTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

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

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getOwnClassTimetableForToday

• getOwnClassTimetableForToday(validateSession?): Promise<Lesson[]>

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

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getOwnTimetableFor

• getOwnTimetableFor(date, validateSession?): Promise<Lesson[]>

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

  Parameters

  • date: Date

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getOwnTimetableForRange

• getOwnTimetableForRange(rangeStart, rangeEnd, validateSession?): Promise<Lesson[]>

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

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getOwnTimetableForToday

• getOwnTimetableForToday(validateSession?): Promise<Lesson[]>

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

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getOwnTimetableForWeek

• getOwnTimetableForWeek(date, formatId?, validateSession?): Promise<WebAPITimetable[]>

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

  Parameters

  • date: Date

    one date in the week to query

  • Optional formatId: number = 1

    set to 1 to include teachers, 2 omits the teachers in elements response

  • Optional validateSession: boolean = true

  Returns Promise<WebAPITimetable[]>

getPdfOfAbsentLesson

• getPdfOfAbsentLesson(rangeStart, rangeEnd, validateSession?, excuseStatusId?, lateness?, absences?, excuseGroup?): Promise<string>

• Returns a URL to a unique PDF of all the lessons you were absent

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • Optional validateSession: boolean = true

  • Optional excuseStatusId: number = -1

  • Optional lateness: boolean = true

  • Optional absences: boolean = true

  • Optional excuseGroup: number = 2

  Returns Promise<string>

getRooms

• getRooms(validateSession?): Promise<Room[]>

• Get all known rooms by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Room[]>

getSchoolyears

• getSchoolyears(validateSession?): Promise<SchoolYear[]>

• Get all WebUntis Schoolyears

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<SchoolYear[]>

getStatusData

• getStatusData(validateSession?): Promise<StatusData>

• Get all status data known by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<StatusData>

getStudents

• getStudents(validateSession?): Promise<Student[]>

• Get all known students by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Student[]>

getSubjects

• getSubjects(validateSession?): Promise<Subject[]>

• Get all known Subjects for the current logged-in user

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Subject[]>

getTeachers

• getTeachers(validateSession?): Promise<Teacher[]>

• Get all known teachers by WebUntis

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Teacher[]>

getTimegrid

• getTimegrid(validateSession?): Promise<Timegrid[]>

• Get the timegrid of current school

  Parameters

  • Optional validateSession: boolean = true

  Returns Promise<Timegrid[]>

getTimetableFor

• getTimetableFor(date, id, type, validateSession?): Promise<Lesson[]>

• Get the timetable for a specific day for a specific element.

  Parameters

  • date: Date

  • id: number

  • type: number

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getTimetableForRange

• getTimetableForRange(rangeStart, rangeEnd, id, type, validateSession?): Promise<Lesson[]>

• Get the timetable for a given Date range for specific element

  Parameters

  • rangeStart: Date

  • rangeEnd: Date

  • id: number

  • type: number

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getTimetableForToday

• getTimetableForToday(id, type, validateSession?): Promise<Lesson[]>

• Get the timetable of today for a specific element.

  Parameters

  • id: number

  • type: number

  • Optional validateSession: boolean = true

  Returns Promise<Lesson[]>

getTimetableForWeek

• getTimetableForWeek(date, id, type, formatId?, validateSession?): Promise<WebAPITimetable[]>

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

  Parameters

  • date: Date

    one date in the week to query

  • id: number

    element id

  • type: number

    element type

  • Optional formatId: number = 1

    set to 1 to include teachers, 2 omits the teachers in elements response

  • Optional validateSession: boolean = true

  Returns Promise<WebAPITimetable[]>

login

• login(): Promise<SessionInformation>

• Login with your credentials

  Notice: The server may revoke this session after less than 10min of idle.

  Untis says in the official docs:

  An application should always log out as soon as possible to free system resources on the server.

  Returns Promise<SessionInformation>

logout

• logout(): Promise<boolean>

• Logout the current session

  Returns Promise<boolean>

validateSession

• validateSession(): Promise<boolean>

• Checks if your current WebUntis Session is valid

  Returns Promise<boolean>

Static convertDateToUntis

• convertDateToUntis(date): string

• Convert a JS Date Object to a WebUntis date string

  Parameters

  • date: Date

  Returns string

Static convertUntisDate

• convertUntisDate(date, baseDate?): Date

• Converts the untis date string format to a normal JS Date object

  Parameters

  • date: string

    Untis date string

  • Optional baseDate: Date = ...

    Base date. Default beginning of current day

  Returns Date

  Static

Static convertUntisTime

• convertUntisTime(time, baseDate?): Date

• Convert a untis time string to a JS Date object

  Parameters

  • time: string | number

    Untis time string

  • Optional baseDate: Date = ...

    Day used as base for the time. Default: Current date

  Returns Date

  Static