webuntis v2.1.1 Webuntis

Documentation for Webuntis.

This library is no longer being developed. Please use https://github.com/xp4u1/untis.

Link to this section Summary

Functions

List all absences for the given range. Returns Webuntis.Struct.Absence structs

List all homework for the given range. Example

List the messages of the day.

This is the same as timetable_student but for classes.

Display the timetable for the given time. Example usage for today

This returns a lot of data

Link to this section Functions

Link to this function

absences(start_date, end_date, include_excused, include_unexcused)

(since 2.0.0)

List all absences for the given range. Returns Webuntis.Struct.Absence structs

Link to this function

homework_student(id, start_date, end_date)

(since 2.0.0)

List all homework for the given range. Example:

homework_student(
    889,
    Date.utc_today(),
    Date.utc_today() |> Date.add(7)
  )
Link to this function

messages(date)

(since 2.0.0)

List the messages of the day.

Link to this function

timetable_class(id, start_date, end_date)

(since 2.0.0)

This is the same as timetable_student but for classes.

Link to this function

timetable_student(id, start_date, end_date)

(since 2.0.0)

Display the timetable for the given time. Example usage for today:

timetable_student(889, Date.utc_today(), Date.utc_today())
Link to this function

userdata()

(since 2.0.0)

This returns a lot of data:

  • master data (used internal to resolve elements)
  • settings
  • messenger settings
  • "real" user data (e.g. student id, display name etc.)