Librus icon

Librus

Read data from Librus Synergia (unofficial)

Overview

This node integrates with the Librus API, a platform commonly used by schools for managing educational data such as homework, calendars, messages, absences, and grades. The "Get Calendar" operation under the "Homework" resource retrieves calendar data, typically representing school events or schedules for a specified month and year.

Use cases include:

  • Fetching a student's or class's calendar events for a given month and year.
  • Integrating school calendar data into other workflows or dashboards.
  • Automating reminders or notifications based on upcoming school events.

Example: Retrieve the calendar for March 2024 to display all scheduled school activities in an external app.

Properties

Name Meaning
From Optional start date filter in YYYY-MM-DD format to limit results to events after this date.
To Optional end date filter in YYYY-MM-DD format to limit results to events before this date.
Custom method name Advanced option to override the default API method called (e.g., to call a different underlying function).

Note: Although the properties are defined for multiple resources, for the "Homework" resource and "Get Calendar" operation, the relevant filters are mainly the date range (From, To) and optionally the custom method name.

Output

The output is a JSON array where each item represents a calendar event object retrieved from the Librus API. Each event object contains details about a specific calendar entry such as dates, descriptions, and possibly related metadata.

If multiple events are returned, they are flattened into a single array of objects. If no events are found, the output will be an empty array.

No binary data is produced for this operation.

Dependencies

  • Requires valid credentials for the Librus API (an API login and password).
  • Uses an internal client wrapper to communicate with the Librus API.
  • No additional environment variables or external services beyond the Librus API are required.

Troubleshooting

  • No supported method found error: This occurs if the node cannot find a matching API method for the selected resource and operation. Ensure the resource and operation names are correct and supported by the current version of the node.
  • Empty results: If the calendar returns no events, verify that the date range (From and To) is set correctly and that there are events within that period.
  • Authentication errors: Check that the provided API credentials are valid and have sufficient permissions.
  • Custom method name misuse: Using an incorrect or unsupported custom method name may cause failures. Use this only if you know the exact underlying API method to call.

Links and References

Discussion