Bakalari icon

Bakalari

Interact with Bakalari school system API

Actions3

Overview

This node interacts with the Bakalari school system API, specifically focusing on managing messages (referred to as "Komens"). The "Get Sent" operation retrieves messages that have been sent by the user within the Bakalari system. This is useful for scenarios where users want to review or process their outgoing communications, such as tracking sent notices, verifying message delivery, or exporting sent messages for record-keeping.

Practical examples include:

  • A teacher retrieving all messages they have sent to students or parents.
  • An administrator auditing sent communications for compliance.
  • Exporting sent messages to another system for backup or analysis.

Properties

Name Meaning
Additional Fields Optional extra parameters to customize the request. Currently supports:
- Limit Maximum number of sent messages to return. Accepts a number between 1 and 1000.

Output

The output is an array of JSON objects representing individual sent messages. Each object contains the original message fields returned by the Bakalari API, augmented with two additional properties:

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

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

Example structure of one item in the output JSON array:

{
  "id": "...",
  "subject": "...",
  "body": "...",
  "dateSent": "...",
  // other message-specific fields from the API
  "operation": "getSent",
  "resource": "komens"
}

No binary data is output by this node.

Dependencies

  • Requires an API key credential with username, password, and school URL to authenticate against the Bakalari API.
  • The node performs an OAuth-like login to obtain an access token before making requests.
  • The node uses HTTP POST requests with appropriate headers (Content-Type and Authorization) to communicate with the Bakalari API endpoints.

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, school URL) are correct and that the Bakalari API 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 these bounds.
  • API connectivity problems: Network issues or incorrect URLs can cause HTTP request failures. Verify network connectivity and endpoint correctness.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion