Librus icon

Librus

Read data from Librus Synergia (unofficial)
Join our community

Actions105

Overview

This node integrates with the Librus API, a platform commonly used in educational environments for managing school-related data. Specifically, the "Calendar" resource with the "List Inbox" operation allows users to retrieve messages from their inbox within the Librus system.

Typical use cases include:

  • Fetching and processing incoming messages or notifications from the school system.
  • Automating message handling workflows such as filtering, archiving, or responding to messages.
  • Integrating school calendar events or announcements into other systems by first retrieving related inbox messages.

For example, a teacher could use this node to automatically pull all new messages received in their Librus inbox during a specified date range and then trigger follow-up actions like sending reminders or logging communications.

Properties

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

Note: The node also internally uses other parameters depending on the operation, such as folder ID, page number, date ranges (from, to), but these are not exposed in the provided input properties JSON.

Output

The output is an array of items where each item contains a json field representing the data retrieved from the Librus API.

  • For the "List Inbox" operation under the Calendar resource, the output JSON typically includes message objects from the user's inbox.
  • If the operation involves fetching files (not applicable here), binary data would be returned encoded in base64 with appropriate MIME type and filename metadata.
  • The node supports filtering results by date range internally before outputting them.

Example output structure (simplified):

[
  {
    "json": {
      "id": "messageId",
      "title": "Message title",
      "content": "Message content",
      "date": "2024-01-01T12:00:00Z",
      ...
    }
  },
  ...
]

Dependencies

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

Troubleshooting

  • No supported method found error: This occurs if the node cannot find a matching API method for the selected resource and operation. Ensure that the resource and operation names are correct and supported by the current version of the node.
  • Authentication errors: Invalid or expired credentials will cause failures connecting to the Librus API. Verify that the login and password are correct.
  • Empty or unexpected results: Check date range filters (from, to) and pagination parameters to ensure they match the expected query scope.
  • Custom method usage: If specifying a custom method name, ensure it exists in the underlying API client; otherwise, the node will throw an error listing available methods.

Links and References

Discussion