Manage a Learners Learning Plan via the API

Introduction

It is possible to update a learners training plan via the API through a handful of endpoints. This will be useful for Customers who have other learning delivery solutions outside of Bud, allowing learners to complete work that is then synchronised with the Learning Plan in Bud. End-points provide capability to complete an activity, submit work against an activity and add messages to an activity,

Get a Learners Learning Plan

With this endpoint, you can get the entire Learning Plan for an individual learner, including some additional details about the Learner. 

Some information this returns: 

• The Learners name.
• The name of the Programme the learner is on.
• The Learners status, such as In Progress or On a Break. 
• A list of their activities, which includes:
  • Activity IDs
  • Activity name
  • Activity status, such as Unset, In Progress or Completed. 
  • If the activity has been exempted for that Learner. 

The Activity ID returned in this call is the ID required for the following activity endpoints. 

Add a submission to a Learners activity

This allows you to submit work against an activity, which is useful for Customers who utilise other platforms to deliver content to learners and want to reflect that in Bud. You can add a file and include a message comment. File size is restricted to 400mbs. 

Here's how this would look in the activity after applying the submission:

Note, you need the learning plan ID and activity ID, obtained through the Get Learners Learning Plan end-point. 

Complete a Learners activity

Like adding submissions to an activity, this endpoint allows you to mark an activity as completed, and to include a file submission along with it. This is useful for Customers who utilise other platforms to deliver content to learners and want to reflect that in Bud.

Note, you need the learning plan ID and activity ID, obtained through the Get Learners Learning Plan end-point. 

Once used, the activity status is set to 'Complete'

Bud Recommends

If you want to submit, or complete an activity, you will first need to know the Activities ID. There are two methods of doing this with Bud, via the API or the DWH. Below shows the flow of those two options. 

If using the Get Learning Plan endpoint to get the Activity ID:

If using the DWH to get the Activity ID: