LearningSuite icon

LearningSuite

Interact with LearningSuite API (powered by agentur-systeme.de)

Overview

The node provides a generic API call capability to interact with the LearningSuite platform's REST API. It allows users to make HTTP requests (GET, POST, PUT, PATCH, DELETE) to any specified endpoint within the LearningSuite API, enabling flexible integration scenarios.

Common use cases include:

  • Retrieving data from various LearningSuite resources by specifying GET requests.
  • Creating or updating resources by sending JSON payloads in POST, PUT, or PATCH requests.
  • Deleting resources using DELETE requests.
  • Adding custom query parameters to refine or filter API responses.

This node is beneficial when predefined operations do not cover specific API endpoints or when users want to perform custom API interactions without waiting for new node features.

Example:

  • Fetching a list of courses for a member: Set HTTP Method to GET and Endpoint to /members/123/courses.
  • Creating a new course: Use POST method with Endpoint /courses and provide course details in the Request Body as JSON.
  • Updating a course's information: Use PATCH method on /courses/456 with updated fields in the Request Body.

Properties

Name Meaning
HTTP Method The HTTP method to use for the API call. Options: DELETE, GET, PATCH, POST, PUT
Endpoint The API endpoint path relative to the base URL (e.g., /members/123/courses)
Request Body JSON object representing the request payload; required only for POST, PUT, and PATCH methods
Query Parameters A collection of key-value pairs to be appended as query parameters to the API request

Output

The node outputs an array of JSON objects representing the response(s) returned by the LearningSuite API for each input item processed.

  • The json field contains the parsed JSON response from the API.
  • If the API returns multiple items or paginated results, these are flattened into the output array.
  • The node does not explicitly handle binary data output.

Dependencies

  • Requires a configured API authentication credential for LearningSuite, including the base URL and an API key or token.
  • The node uses standard HTTP headers (Accept: application/json, Content-Type: application/json).
  • No additional external services or environment variables are needed beyond the API credential.

Troubleshooting

  • No handler error: If you see an error like No handler for resource "apiCall" and operation "makeRequest", ensure that the Resource is set to "API Call" and Operation to "Make Request".
  • Invalid JSON in Request Body: For POST, PUT, PATCH methods, ensure the Request Body is valid JSON; otherwise, the API call will fail.
  • Endpoint errors: Verify the correctness of the Endpoint path; incorrect paths may result in 404 or other HTTP errors.
  • Authentication failures: Check that the API credential is correctly configured and has necessary permissions.
  • Query parameter issues: Ensure query parameter names and values are properly set; malformed parameters can cause unexpected API responses.

Links and References

Discussion