Bakalari icon

Bakalari

Interact with Bakalari school system API

Actions3

Overview

This node interacts with the Bakalari school system API to retrieve messages related to the "Messages (Komens)" resource. Specifically, the "Get Noticeboard" operation fetches messages posted on the school's noticeboard. This is useful for automating the retrieval of important announcements or updates shared within a school environment.

Practical examples include:

  • Automatically fetching and displaying the latest noticeboard messages in a dashboard.
  • Triggering workflows based on new noticeboard announcements.
  • Archiving or processing noticeboard messages for reporting purposes.

Properties

Name Meaning
Additional Fields Optional extra parameters to customize the request. Currently supports:
- Limit Maximum number of noticeboard messages to return (number between 1 and 1000). Defaults to 50.

Output

The node outputs an array of message objects under the json field. Each object represents a single noticeboard message and includes all properties returned by the Bakalari API for that message. Additionally, each output item contains two metadata fields:

  • operation: The operation performed, here always "getNoticeboard".
  • resource: The resource type, here always "komens".

If no messages are found, the output will contain the raw response from the API.

No binary data is output by this node.

Dependencies

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

Troubleshooting

  • No access token received: If the login response does not include an access token, the node throws an error showing the full response. Check that the provided credentials (username, password, and school URL) are correct and that the API endpoint is reachable.
  • Unsupported operation: If an invalid operation is specified, the node throws an error indicating the operation is not supported.
  • Limit parameter issues: Setting the limit outside the allowed range (1 to 1000) may cause unexpected results or errors. Ensure the limit is within the valid range.
  • API connectivity problems: Network issues or incorrect URLs can cause HTTP request failures. Verify network connectivity and API endpoint correctness.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output.

Links and References

Discussion