WebUntis icon

WebUntis

Gathers WebUntis data

Actions5

Overview

This node integrates with the WebUntis API to retrieve timetable data for schools. Specifically, the "Timetable" resource with the "Get Week" operation fetches the timetable for a single week based on a specified date. This is useful for educational administrators, teachers, or students who want to programmatically access weekly schedules from their school's WebUntis system.

Practical examples include:

  • Automatically fetching and displaying the upcoming week's class schedule in a dashboard.
  • Integrating timetable data into other school management tools or notification systems.
  • Generating reports or alerts based on weekly timetable changes.

Properties

Name Meaning
Date The date (in YYYY-MM-DD format) for which to retrieve the timetable week.
School Name The name of the school in Untis notation; identifies the specific school instance.
Base URL The base URL of the WebUntis instance to connect to (e.g., https://school.webuntis.com).

Output

The node outputs an array of items where each item's json field contains the timetable data for the requested week. The structure of this JSON corresponds to the WebUntis API's timetable response for one week, including lessons, periods, rooms, teachers, and subjects as applicable.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the WebUntis API: a username and password must be configured in the node's credentials.
  • Needs network access to the specified WebUntis base URL.
  • Uses the external moment-timezone library internally for date formatting.
  • Relies on the internal getInfo and getData functions from a bundled Untis helper library to interact with the WebUntis API.

Troubleshooting

  • Common issues:

    • Incorrect or missing credentials will cause authentication failures.
    • An invalid or unreachable Base URL will result in connection errors.
    • Providing a date outside the valid range or in an incorrect format may lead to empty or error responses.
    • If the school name does not match the Untis notation exactly, the API may return no data.

  • Error messages:

    • Errors are wrapped and thrown as WebUntis API Error: <original error>.
    • To resolve, verify credentials, check the Base URL, confirm the school name, and ensure the date is correctly formatted.

Links and References

Discussion