Bakalari icon

Bakalari

Interact with Bakalari school system API
Join our community

Actions3

Overview

This node interacts with the Bakalari school system API to retrieve messages related to the "Messages (Komens)" resource. Specifically, the Get Sent operation fetches messages that have been sent by the user or system within the Bakalari platform.

Typical use cases include:

  • Extracting a list of sent messages for auditing or record-keeping.
  • Filtering sent messages by date range, read status, confirmation status, sender type, or text search.
  • Integrating sent message data into workflows for notifications, reporting, or further processing.

For example, a school administrator could use this node to pull all sent messages from teachers within the last month that have not yet been confirmed as read by recipients.

Properties

Name Meaning
Limit Max number of results to return (1 to 1000).
From Date Filter messages sent from this date (inclusive).
To Date Filter messages sent up to this date (inclusive).
Read Status Filter messages by read status: All, Read Only, or Unread Only.
Confirmation Status Filter messages by confirmation status: All, Confirmed Only, or Not Confirmed Only.
Search Text Search string to filter messages by title or content (case-insensitive substring match).
Sender Type Filter messages by sender type: All, Teacher, Student, Administrator, or Parent.
Skip Recipients Whether to exclude recipient-related data from output (recommended for cleaner display): Yes/No.

Output

The node outputs an array of JSON objects representing the sent messages matching the specified filters. Each message object includes fields such as:

  • Title: The message title.
  • Text: The message content.
  • SentDate: Timestamp when the message was sent.
  • Read: Boolean indicating if the message has been read.
  • Confirmed: Boolean indicating if the message has been confirmed.
  • Sender: Object containing sender details including Type.
  • Optionally, Recipients, RecipientsRead, and RecipientsConfirmed arrays unless excluded by the "Skip Recipients" property.

Each output item also contains metadata fields operation ("getSent") and resource ("komens") to identify the context.

The node does not output binary data.

Dependencies

  • Requires an API key credential with username, password, and school URL to authenticate against the Bakalari API.
  • Uses OAuth2 password grant flow to obtain an access token before making requests.
  • The node makes HTTP POST requests to endpoints under /api/3/komens/messages/sent.

Troubleshooting

  • No access token received: This error occurs if authentication fails or the API response does not contain an access token. Verify credentials and network connectivity.
  • Unsupported operation: If an invalid operation is selected, the node throws an error. Ensure the operation is one of the supported options.
  • Empty or missing messages: If no messages are returned, check filter criteria such as date ranges and search text.
  • API request failures: Network issues or incorrect school URL can cause HTTP errors. Confirm endpoint accessibility and credentials.
  • Large result sets: Setting a very high limit may impact performance; consider using pagination or smaller limits.

Links and References

Discussion