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 "Rooms" resource with the "Get Many" operation, it fetches a list of all rooms available in a specified school's WebUntis instance.

Common scenarios where this node is beneficial include:

  • Automatically syncing room data from WebUntis into other systems such as calendar apps or facility management tools.
  • Generating reports or dashboards that require up-to-date information about available rooms.
  • Using room data as part of broader automation workflows involving school timetables and resources.

For example, a school administrator could use this node to pull all room details daily and update their internal booking system without manual entry.

Properties

Name Meaning
School Name Name of the school in Untis notation; identifies which school's data to access.
Base URL Base URL of the WebUntis instance; the endpoint used to connect to the WebUntis API.

Output

The node outputs an array of items, each containing a JSON object representing the fetched data.

For the "Rooms" resource with the "Get Many" operation, the json output field contains an array of room objects retrieved from WebUntis. Each room object typically includes details such as room identifiers, names, and possibly additional metadata depending on the WebUntis API response.

No binary data output is produced by this operation.

Example structure of one output item (simplified):

{
  "json": [
    {
      "id": 101,
      "name": "Room A1",
      "longName": "Building A - Room 1"
      // ... other room properties
    },
    {
      "id": 102,
      "name": "Room B2",
      "longName": "Building B - Room 2"
      // ... other room properties
    }
    // ... more rooms
  ]
}

Dependencies

  • Requires valid credentials for the WebUntis API, including username and password.
  • Needs the base URL of the target WebUntis instance.
  • Depends on the external WebUntis API service being accessible and responsive.
  • Uses the moment-timezone library internally for date formatting.
  • The node expects the WebUntis API to provide session management and data retrieval endpoints.

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: Ensure the "School Name" matches exactly the notation used in your WebUntis instance; otherwise, the API may return no data or errors.
  • Base URL issues: Confirm the base URL is correct and reachable from the n8n environment. Network issues or incorrect URLs will cause connection failures.
  • API errors: The node wraps API errors with a message starting with "WebUntis API Error:". Check the underlying error message for clues, such as rate limits or malformed requests.
  • Empty results: If the output is empty, verify that the school has rooms defined in WebUntis and that the API user has access rights to view them.

Links and References

Discussion