LearningSuite icon

LearningSuite

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

Overview

This node integrates with the LearningSuite API to create a new lesson within a specified course module section. It is useful for automating course content management workflows, such as adding lessons programmatically during course creation or updates.

Typical use cases include:

  • Automatically adding lessons to an online course after content preparation.
  • Inserting video lessons with thumbnails and HTML content into specific modules and sections.
  • Publishing the course immediately after lesson creation to make new content live without manual intervention.

For example, an educator could use this node to add a video lesson titled "Introduction to Algebra" to the first section of a math course module, optionally including formatted HTML content and setting a thumbnail image.

Properties

Name Meaning
Course Name or ID The identifier of the course where the lesson will be created. Choose from a list of available courses or specify an ID using an expression.
Module Name or ID The module within the course where the lesson will be added. This can be selected from a filtered list based on the chosen course or specified by ID via expression.
Section Name or ID The section inside the selected module where the lesson will be created. Select from a list or specify an ID using an expression.
Lesson Name The title of the new lesson to be created.
Lesson Sort Position Determines whether the new lesson is placed at the beginning ("First") or end ("Last") of the section.
Immediately Publish Course A boolean flag indicating if the course should be published immediately after creating the lesson and its page. Warning: publishing includes all changes since the last release, so ensure content is final.
Additional Options A collection of optional parameters to customize the lesson further:
- HTML Content Formatted HTML text and images to be parsed and inserted into the lesson page after any video content.
- Lesson Description A textual description of the lesson.
- Thumbnail Timestamp (Sec) The second mark in the video from which to capture a thumbnail image, applicable only if a video URL is provided.
- Thumbnail URL A direct-downloadable image URL to be used as the lesson and video thumbnail. No authentication headers supported.
- Video URL A direct-downloadable video URL to embed as the first element on the lesson page. If no explicit thumbnail is set, the first frame of this video will be used as the thumbnail.

Output

The node outputs JSON data representing the newly created lesson object as returned by the LearningSuite API. This typically includes details such as lesson ID, name, description, associated module and section IDs, URLs for video and thumbnail, and publication status.

If binary data were involved (e.g., uploading files), it would be summarized here, but this node handles only JSON content related to lesson creation.

Dependencies

  • Requires a valid API key credential for authenticating with the LearningSuite API.
  • The node depends on the LearningSuite service being accessible via the configured base URL.
  • Proper permissions are needed to create lessons and publish courses within the target LearningSuite account.

Troubleshooting

  • Common Issues:

    • Invalid or missing course/module/section IDs may cause errors; ensure these are correct and exist.
    • Attempting to publish immediately when there are unreviewed changes might lead to unintended content going live.
    • Providing invalid URLs for video or thumbnail may result in failed media embedding.
  • Error Messages:

    • "No handler for resource "course" and operation "createLesson": Indicates a misconfiguration or unsupported operation; verify resource and operation selections.
    • API errors related to authorization or permissions: Check that the API key credential is valid and has sufficient rights.
    • Validation errors about required fields: Ensure all mandatory properties like courseId, moduleId, sectionId, and lessonName are provided.
  • Resolution Tips:

    • Use the load options dropdowns to select valid courses, modules, and sections to avoid ID mistakes.
    • Review the warning about immediate publishing carefully before enabling it.
    • Validate URLs and timestamps for media content before execution.

Links and References

Discussion