Create/Update learning path

Method

Method Description
learningpath.learningPathCreate Create learning path.
learningpath.learningPathUpdate Update learning path.

Request parameters

{
    "learning_path": {
        "id": {LearningPathId}, /* Only for update operation */
        "title": "{LearningPathTitle}",
        "description": "{Description}"
    },
    "resources": {
        "{ResourcePath}": "{ResourceCnt}",
        ...
    }
}

Response parameters

{
    "learning_path": {
        "id": {LearningPathId},
        ...
    },
    "resources": {
        "{ResourcePath}": "{NewResourcePath}",
        ...
    },
    "completed": {Completed}
}

If a specific option is completely omitted from the update request, it will not be updated, and the previously stored value will be preserved.

Units (assessments and courses) are added to the learning path with unit add operation. Publish settings of the learning path are managed on the website.

Variable Type Appearance Description
{LearningPathId} Integer Mandatory Learning path id.
{LearningPathTitle} String Mandatory on create Learning path title, up to 250 characters. Must be unique among your learning paths.
{Description} String Optional Learning path description content. HTML formatted, may contain media resources like images and audio. Please be aware that only relative URLs are allowed. See Rich HTML formatting for the full list of supported tags and attributes. If omitted from the update request, the existing value is preserved and not cleared.
resources Object Optional If you are using media resources like images you need to send the content of each media resource under "resources" node.
{ResourcePath} String Mandatory Path of media resource. Same value as it was used in Description.
Example: "fld/image.jpg" for <img src="fld/image.jpg">.
{ResourceCnt} String Mandatory Base64 encoded content of media resource.
{NewResourcePath} String Mandatory New media resource path.
{Completed} Boolean Mandatory Indicates whether action was successfully completed or not.