WebUntis icon

WebUntis

Gathers WebUntis data

Actions5

Overview

This node integrates with the WebUntis API to retrieve data related to school scheduling and resources. Specifically, for the "Subjects" resource with the "Get Many" operation, it fetches a list of all subjects available in a specified school's WebUntis instance.

Common scenarios where this node is beneficial include:

  • Importing or synchronizing subject lists from WebUntis into other systems.
  • Automating reporting or analytics based on subjects offered by a school.
  • Building custom timetable or curriculum management tools that require subject metadata.

Practical example:

  • A school administrator wants to export all subjects from their WebUntis system to a learning management platform. Using this node, they can easily pull the full subject list programmatically.

Properties

Name Meaning
School Name Name of the school in Untis notation (required). Specifies which school's data to query.
Base URL Base URL of the WebUntis instance (required). The endpoint used to connect to the API.

Output

The node outputs an array of JSON objects under the json field. For the "Subjects" resource with "Get Many" operation, each item contains the full list of subjects retrieved from WebUntis. The structure typically includes subject identifiers, names, and possibly additional metadata as provided by the WebUntis API.

No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "json": [
    {
      "id": 101,
      "name": "Mathematics",
      "longName": "Advanced Mathematics"
    },
    {
      "id": 102,
      "name": "Physics",
      "longName": "General Physics"
    }
    // ... more subjects
  ]
}

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrect or missing school name or base URL will cause API connection failures.
    • Invalid credentials will result in authentication errors.
    • Network connectivity problems to the WebUntis server can cause timeouts or unreachable errors.

  • Error messages:

    • WebUntis API Error: ... indicates an issue returned from the WebUntis API or during communication.

  • Resolutions:

    • Verify the school name matches the Untis notation exactly.
    • Confirm the base URL is correct and accessible.
    • Check that the API credentials are valid and have sufficient permissions.
    • Ensure your environment allows outbound connections to the WebUntis server.

Links and References

Discussion