Actions3
- Messages (Komens) Actions
Overview
This node integrates with the Bakalari school system API to retrieve messages from different message categories (called "komens"). It supports fetching messages from the noticeboard, received messages, and sent messages. This is useful for automating workflows that involve school communications, such as monitoring announcements, tracking incoming messages, or reviewing sent correspondence.
Practical examples include:
- Automatically retrieving the latest noticeboard announcements to post them elsewhere.
- Collecting received messages for further processing or alerts.
- Archiving sent messages for record-keeping.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional extra parameters; currently supports: |
| - Limit | Maximum number of results to return (number between 1 and 1000) |
Output
The output is an array of JSON objects representing messages retrieved from the selected resource and operation. Each item includes all fields returned by the Bakalari API for a message, augmented with two additional properties:
operation: The operation performed (e.g., "getNoticeboard", "getReceived", "getSent").resource: The resource name ("komens").
If multiple messages are returned, they are output as separate items. If no array of messages is found, the entire response object is output as a single item.
No binary data is produced by this node.
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.
- Requires network access to the Bakalari school system API endpoints.
Troubleshooting
- No access token received: Indicates authentication failure. Verify the provided credentials (username, password, and school URL) are correct and the API is reachable.
- Unsupported operation error: Occurs if an invalid operation is specified. Ensure the operation is one of "Get Noticeboard", "Get Received", or "Get Sent".
- Empty or unexpected response: If the API returns no messages or a malformed response, check the API status and parameters like the limit.
- Rate limiting or API errors: The node does not explicitly handle rate limits; repeated failures may require adding delays or retries externally.
Links and References
- Bakalari School System API Documentation (Note: link is illustrative; actual documentation URL should be confirmed)