webuntis v1.0.1 Webuntis

Documentation for Webuntis.

Link to this section Summary

Functions

Returns the date of the current day.

Returns the internal id of the student's class. Example: 237

Returns the last update of the timetable in NaiveDateTime.

Returns news for the current day.

Returns the periods for the day at the given date.

Returns the internal id of the student. Example: 889

Returns the timetable for the week which starting at the given date.

Returns an ics file for the current week.

Returns the raw json response. Don't use it if you don't know what you're doing!

Returns the timetable of the student for the current week. Same as

Link to this section Functions

Returns the date of the current day.

Returns the internal id of the student's class. Example: 237

Requires authentication

Returns the last update of the timetable in NaiveDateTime.

Requires authentication

Returns news for the current day.

Link to this function

periods(timetable_week, date)

(since 1.0.1)

Returns the periods for the day at the given date.

Example usage:

timetable_student()
|> periods("")

Returns the internal id of the student. Example: 889

Requires authentication

Link to this function

timetable(type, id, date)

Returns the timetable for the week which starting at the given date.

Requires authentication

Link to this function

timetable_ics(type, id, date, base_url \\ "mese.webuntis.com")

Returns an ics file for the current week.

Example: Webuntis.timetable_ics(5, Webuntis.student_id(), Webuntis.current_date())

Requires authentication

Link to this function

timetable_raw(type, id, date)

(since 0.1.1)

Returns the raw json response. Don't use it if you don't know what you're doing!

Requires authentication

Link to this function

timetable_student()

Returns the timetable of the student for the current week. Same as:

Webuntis.timetable_student(Webuntis.student_id(), Webuntis.current_date())

Requires authentication