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 from the "Messages (Komens)" resource. Specifically, the Get Received operation fetches received messages for the authenticated user. It supports filtering and searching through these messages based on various criteria such as date range, read status, confirmation status, sender type, and text content.

Typical use cases include:

  • Automatically fetching recent received messages for processing or notification.
  • Filtering unread or unconfirmed messages to prioritize responses.
  • Searching messages by keywords in title or content.
  • Excluding recipient details for cleaner output when recipients are not needed.

For example, a school administrator could use this node to pull all unread messages from teachers within the last week to ensure timely follow-up.

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 matching text in title or content (case-insensitive).
Sender Type Filter messages by sender type: All, Teacher, Student, Administrator, or Parent.
Skip Recipients Whether to exclude Recipients data from the output (recommended for cleaner display): Yes or No.

Output

The node outputs an array of message objects under the json field. Each message object contains fields returned by the Bakalari API, including but not limited to:

  • Title: The message title.
  • Text: The message content.
  • SentDate: The date/time 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 their type.
  • Recipients, RecipientsRead, RecipientsConfirmed: Arrays with recipient information (excluded if "Skip Recipients" is set to Yes).

Additionally, each output item includes metadata fields operation ("getReceived") and resource ("komens") to identify the context.

No binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Bakalari school system API.
  • The node performs an OAuth-like login request to obtain an access token before making API calls.
  • The base URL of the Bakalari school system (schoolUrl) and user credentials must be configured in the credential settings.

Troubleshooting

  • No access token received: This error occurs if the login request fails or returns no token. Verify that the API credentials (username, password, and school URL) are correct and that the Bakalari API is reachable.
  • Unsupported operation: If an invalid operation is selected, the node will throw an error. Ensure the operation name matches one of the supported options.
  • Empty or missing messages: If no messages are returned, check the filter parameters (dates, read/confirmation status, sender type, search text) to ensure they are not overly restrictive.
  • HTTP request failures: Network issues or incorrect API URLs can cause request errors. Confirm connectivity and endpoint correctness.
  • Large result sets: Setting a very high limit may impact performance; consider using pagination or smaller limits.

Links and References

Discussion