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 supporting the "Get Noticeboard" operation. It fetches noticeboard messages posted within the school system and allows filtering by various criteria such as date range, read status, confirmation status, sender type, and text search.

Typical use cases include:

  • Automatically retrieving recent announcements or notices posted on the school's noticeboard.
  • Filtering messages to only show unread or unconfirmed notices for follow-up.
  • Searching for specific topics or keywords in noticeboard messages.
  • Excluding recipient details for cleaner output when recipients are not needed.

For example, a school administrator could use this node to pull all unread noticeboard messages from the past week sent by teachers, helping them stay updated on important communications.

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 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 for noticeboard messages, 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 Type
  • Optionally, Recipients, RecipientsRead, and RecipientsConfirmed arrays unless excluded by the "Skip Recipients" property

Additionally, each output item includes metadata fields operation and resource set to "getNoticeboard" and "komens" respectively.

No binary data is produced by this node.

Dependencies

  • Requires an API key credential with access to the Bakalari school system API.
  • Needs the base school URL, username, and password configured in the credentials.
  • The node performs an OAuth-like login to obtain an access token before making API requests.
  • The HTTP requests use application/x-www-form-urlencoded content type.

Troubleshooting

  • No access token received: If the login response does not contain an access token, the node throws an error. Verify that the provided credentials (school URL, username, password) are correct and that the API endpoint is reachable.
  • Unsupported operation error: If an unsupported operation is selected, the node will throw an error. Ensure the operation is 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.
  • API connectivity issues: Network problems or incorrect URLs can cause request failures. Confirm network access and correct configuration.
  • Large result sets: Setting a very high limit may impact performance; consider using smaller limits and pagination if supported externally.

Links and References

Discussion