Librus icon

Librus

Read data from Librus Synergia (unofficial)
Join our community

Actions105

Overview

This node interacts with a school management system API to manage messages and related data. Specifically, the "Delete Message" operation under the "Messages" resource allows users to delete a message by its ID. This is useful for automating message cleanup or managing inbox content programmatically.

Practical examples include:

  • Automatically deleting outdated or irrelevant messages from a student's or teacher's inbox.
  • Integrating with workflows that archive or process messages before removal.
  • Managing communication channels in bulk based on certain criteria.

Properties

Name Meaning
From Optional start date filter (format: YYYY-MM-DD) to limit data retrieval by date range.
To Optional end date filter (format: YYYY-MM-DD) to limit data retrieval by date range.
Custom method name Advanced option to override the default API method called (e.g., specify a custom method).
Message ID The unique identifier of the message to delete. Required for the Delete Message operation.

Output

The output JSON contains the response from the API after attempting to delete the specified message. Typically, this will be an object indicating success or failure of the deletion request. The exact structure depends on the underlying API but generally confirms whether the message was removed.

No binary data output is produced by the Delete Message operation.

Dependencies

  • Requires an API key credential for authentication with the external school management system.
  • Uses an internal client wrapper to communicate with the API.
  • Date filtering utilities are used when applicable.
  • No additional environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Message ID will likely cause the deletion to fail.
    • Missing or incorrect API credentials will prevent successful connection and operation.
    • Using an unsupported custom method name may result in errors about missing methods.

  • Error messages:

    • "No supported method found for resource...": Indicates the requested operation or custom method does not exist in the API client. Verify the operation name and any custom method overrides.
    • API authentication errors: Check that the provided API key or login credentials are correct and have sufficient permissions.
    • Date filters ("From" and "To") do not affect deletion but may impact other operations; ensure correct format if used elsewhere.

Links and References

Discussion