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. It allows users to retrieve various types of information such as messages, homework, absences, calendar events, and student grades. The node is useful for automating workflows that involve accessing school-related data, such as fetching homework assignments within a date range or listing inbox messages.

A practical example would be automatically retrieving all homework assignments for a specific subject and time period to generate reminders or reports. Another use case is fetching notifications or messages from the school’s messaging system to integrate them into other communication tools.

Properties

Name Meaning
Custom method name (Advanced) Override the default Librus API method to call. For example, specify "getMarks".

Note: The node also internally uses many other parameters depending on the resource and operation selected, such as date ranges (from, to), IDs (folderId, messageId, homeworkId, etc.), pagination (page), and others, but only the above property was provided explicitly.

Output

The output is an array of items where each item contains a json field holding the data returned from the Librus API call. The structure of the JSON depends on the selected resource and operation:

  • For list operations (e.g., listing homework, messages, subjects), the output is an array of objects representing each entity.
  • For single entity retrieval (e.g., getHomework, getMessage), the output is a single object wrapped in an array.
  • When fetching files (e.g., messages.getFile), the node outputs binary data encoded in base64 under a binary property (default named "data"). This includes the file content, MIME type, and filename.

Dependencies

  • Requires valid credentials for the Librus API (login and password).
  • Uses an internal client wrapper around the Librus API.
  • Supports filtering results by date ranges using helper functions.
  • No additional external services are required beyond the Librus API access.

Troubleshooting

  • No supported method found error: Occurs if the specified resource-operation combination or custom method name does not match any available API methods. Verify the resource, operation, and custom method name inputs.
  • Authentication failures: Ensure the provided login and password credentials are correct and have sufficient permissions.
  • Empty or unexpected results: Check date range filters and pagination parameters; incorrect values may result in no data returned.
  • Binary file issues: When downloading files, ensure the binary property name is correctly set and downstream nodes can handle binary data.

Links and References


If you need details about other resources or operations, please provide their names or additional input properties.

Discussion