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. Specifically, the "Calendar" resource with the "Get Message" operation allows users to retrieve messages from the Librus system inbox or related message endpoints.

Typical use cases include:

  • Fetching specific messages or announcements from a school’s communication system.
  • Automating workflows that require reading or processing messages sent via Librus.
  • Integrating Librus messaging data into other systems such as CRM or notification platforms.

For example, a school administrator could use this node to automatically pull new messages from the Librus inbox and forward them to a team chat or archive them in a database.

Properties

Name Meaning
Custom method name (Optional) Override the default underlying API method to call. For example, specify "getMarks" to call a different API method than the default for the selected operation.

Note: The node also internally uses other parameters like folderId, page, messageId, etc., but these are not exposed in the provided properties JSON. They are used internally depending on the operation.

Output

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

  • For message retrieval operations, the json object contains message details such as content, sender, date, and other metadata.
  • If the operation involves fetching a file attachment (messages.getFile), the node outputs binary data under a specified binary property (default "data"). This binary data represents the file content encoded in base64, along with MIME type and filename metadata.

Example output structure for a message might look like:

{
  "json": {
    "id": 123,
    "title": "Meeting Reminder",
    "content": "Don't forget the meeting at 3 PM.",
    "sender": "teacher@example.com",
    "date": "2024-06-01T10:00:00Z"
  }
}

For file attachments:

{
  "json": {
    "path": "/attachments/file.pdf"
  },
  "binary": {
    "data": {
      "data": "<base64-encoded-content>",
      "mimeType": "application/octet-stream",
      "fileName": "file.pdf"
    }
  }
}

Dependencies

  • Requires valid credentials for the Librus API (login and password).
  • Uses an internal client wrapper to communicate with the Librus API.
  • Supports filtering results by date range when applicable.
  • No additional external dependencies beyond the Librus API and n8n environment.

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 Librus API client.
  • Authentication errors: Verify that 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 being returned.
  • Binary data issues: When retrieving files, ensure the binary property name is correctly set and downstream nodes can handle binary data.

Links and References

Discussion