Librus icon

Librus

Read data from Librus Synergia (unofficial)

Overview

This node integrates with the Librus API, a platform commonly used in educational environments for managing school-related information. It allows users to retrieve various types of data such as messages, homework, absences, calendar events, grades, notifications, and account info. The "Get Attachment" operation under the "Info" resource specifically enables fetching attachments related to messages or other entities.

Typical use cases include:

  • Automatically downloading message attachments from the Librus inbox.
  • Retrieving detailed information about grades or notifications.
  • Accessing calendar events or timetable data programmatically.
  • Managing homework assignments and absences by fetching relevant data.

For example, a school administrator could automate the retrieval of all message attachments sent by teachers, or a student could sync their homework assignments with an external task manager.

Properties

Name Meaning
Custom method name Advanced: override the underlying Librus API method to call (e.g., getMarks). If set, this custom method is called instead of the default one for the selected operation.

Note: The node also internally uses many other parameters depending on the resource and operation, such as folderId, page, messageId, userId, title, content, group, attachmentPath, subjectId, homeworkId, absenceId, ttFrom, ttTo, month, year, eventId, eventIsAbsence, etc. However, only the above property was explicitly provided.

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 specific operation performed:

  • For most operations, the JSON contains objects representing messages, homework, absences, calendar events, grades, notifications, or account info.
  • For the "Get Attachment" operation (messages.getFile), the node outputs binary data representing the file attachment:
    • The binary data is base64 encoded.
    • The binary property name can be configured (default is "data").
    • The MIME type is set to "application/octet-stream".
    • The filename is extracted from the attachment path.

If multiple results are returned, they are output as separate items in the array.

Dependencies

  • Requires valid credentials with login and password for the Librus API.
  • Uses an internal client wrapper to communicate with the Librus API.
  • Supports date filtering via helper functions to limit results by date ranges.
  • No additional external services beyond the Librus API are required.

Troubleshooting

  • No supported method found error: This occurs if the requested resource-operation combination or custom method name does not match any available method in the Librus API client. To fix, verify that the resource and operation names are correct and that the custom method name (if used) exists.
  • Authentication errors: Ensure that the provided login and password credentials are correct and have sufficient permissions.
  • Empty or unexpected results: Check date range filters and input parameters to ensure they match existing data.
  • Binary data issues: When retrieving attachments, confirm the attachmentPath is correct and accessible.

Links and References

Discussion