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, you can then update the specifics once you have the appropriate Activity IDs.

 

Input Parameters

Collection Field Name Required? Data Type Validation
  budReferenceNumber No String Like BUD000000000
  dateOfBirth No Date Must be like dd-mm-yyyy

Response

 

Collection Field Name Nullable Data Type

 

ID No GUID
  fullName No String
  programmeId No GUID
  programmeName No String
  budReferenceNumber No String
  uln No String
  statusTitle No String
Activities id No GUID
name No String
statusDescription No String
statusId No Int
isExempt No Boolean

Endpoint GET   /learningPlans

 

Add messages to a Learners activity

This allows you to add a message to a specific activity. Useful for Customers who utilise other platforms to deliver content to learners and want to reflect that in Bud.

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

 

Collection Field Name Required? Data Type Validation
  Comment No  String  

Endpoint PUT   /{activityId}/message

 

Here's how that looks in the Activity. 

 

 

Add a submission to a Learners activity

This allows you to submit work against an activity. 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. 

 

Collection Field Name Required? Data Type Validation
  Comment No  String  
  files No  File File size restricted to 400mb

Endpoint POST   /activity/{LearningPlanId}/{activityId}/submission

 

Here's how that looks in the activity

 

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. 

 

Collection Field Name Required? Data Type Validation
  files No  File File size restricted to 400mb

Endpoint PUT   /activity/{learningPlanId}/{activityId}/complete

 

Sets the activity status to 'Complete'

 

Related to

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request