WebUntis icon

WebUntis

Gathers WebUntis data

Actions5

Overview

This node integrates with the WebUntis system to retrieve timetable data for schools. Specifically, the Get Timeframe operation under the Timetable resource allows users to fetch timetable information spanning multiple weeks starting from a specified date. This is useful for educational administrators, teachers, or students who want to view or process schedules over an extended period rather than just a single week.

Practical examples include:

  • Generating reports of upcoming classes for several weeks.
  • Syncing school timetables with other calendar systems.
  • Automating notifications or reminders based on future class schedules.

Properties

Name Meaning
Date The starting date (in YYYY-MM-DD format) from which to retrieve the timetable.
Look Ahead Weeks Number of weeks to look ahead from the specified date to include in the timetable data.
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 JSON objects where each object contains the timetable data retrieved from WebUntis for the requested timeframe. The structure of the json output field corresponds directly to the raw timetable data returned by the WebUntis API, including details such as lessons, periods, and related metadata.

No binary data is output by this node.

Example output snippet (simplified):

{
  "json": {
    "lessons": [
      {
        "id": 123,
        "date": "2024-06-01",
        "startTime": "08:00",
        "endTime": "09:00",
        "subject": "Mathematics",
        "teacher": "John Doe",
        "room": "101"
      },
      ...
    ],
    "periods": [...],
    "classes": [...],
    ...
  }
}

Dependencies

  • Requires valid credentials for the WebUntis API (username and password).
  • Needs the WebUntis base URL and school name to correctly target the API endpoint.
  • Uses the moment-timezone library internally for date formatting.
  • Relies on the external getInfo and getData functions from a bundled Untis helper library to interact with the WebUntis API.

Troubleshooting

  • Authentication errors: If the node throws errors related to authentication, verify that the provided username and password are correct and have sufficient permissions in WebUntis.
  • Invalid school name or base URL: Ensure the school name matches the Untis notation exactly and the base URL points to a valid WebUntis instance.
  • Date format issues: The date must be in YYYY-MM-DD format. Incorrect formats may cause the API call to fail or return no data.
  • Network or API errors: Temporary network issues or changes in the WebUntis API could cause failures. Check connectivity and confirm the API has not changed.
  • Empty results: If no timetable data is returned, verify that the date and look-ahead weeks cover a period where timetable data exists.

Common error message example:

WebUntis API Error: <detailed error message>

Resolution steps:

  • Review the detailed error message for clues.
  • Confirm all input parameters and credentials.
  • Retry after fixing any identified issues.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion