Untis (untis v1.0.0) View Source

Documentation for Untis.

Code example:

# Requests require a valid login.
Untis.Auth.JsonAuth.login("max.mustermann", "2W9ZNXI472JLVH63", "test-school")

today = Date.utc_today()

Untis.timetable_student(
  420,
  Date.beginning_of_week(today),
  Date.beginning_of_week(today)
  |> Date.add(5)
)

Link to this section Summary

Functions

Returns all absences for the given range. Also see Untis.Struct.Absence structs.

Returns all homework for the given range.

Returns the messages of the day.

Does the same as timetable_student, only for classes.

Returns the timetable for a given time.

Returns a variety of data

Link to this section Functions

Link to this function

absences(start_date, end_date, include_excused, include_unexcused)

View Source

Returns all absences for the given range. Also see Untis.Struct.Absence structs.

Link to this function

homework_student(id, start_date, end_date)

View Source

Returns all homework for the given range.

# List all homework for the next seven days.
homework_student(
    889,
    Date.utc_today(),
    Date.utc_today() |> Date.add(7)
  )

Returns the messages of the day.

Link to this function

timetable_class(id, start_date, end_date)

View Source

Does the same as timetable_student, only for classes.

Link to this function

timetable_student(id, start_date, end_date)

View Source

Returns the timetable for a given time.

# List all periods for today.
timetable_student(889, Date.utc_today(), Date.utc_today())

Returns a variety of data:

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