-2.7 C
New York
Thursday, February 15, 2024

The right way to mark person full for a course by way of API


Abstract:

This text covers API that’s used to mark customers full for a course, pattern payload, pre-requisites and tips on how to receive pre-requisites.

Viewers:

Integration admin position and directors of Adobe Studying Supervisor account.

API endpoints used:

Admin scope  API

POST /customers/{userId}/userModuleGrade

Necessary Pre-requisites to execute the API:

You possibly can skip this step if you have already got obligatory particulars to execute userModuleGrade API.

  1. Consumer ID

  • Consumer for whom the completion ought to be marked
  • To acquire person ID, you’ll be able to execute the API: GET /customers (Retrieves the record of customers for an account)
  1. Course ID

  • Course for which person ought to obtain completion
  • To acquire course ID, you’ll be able to execute API: GET /learningObjects (Retrieves the small print of studying objects)

 

  1. Module ID

  • Programs may have a number of modules (like self-paced, VILT and so forth.,) which defines for which particular module the learner ought to be marked full.
  • To acquire module ID, execute API: GET /learningObjects/{id} (Retrieves the small print of a studying object)
  • Embrace parameter:cases.loResources
  • Enter course ID particulars obtained from earlier API in ‘id’ part in format “course:7968486”. Beneath is screenshot for reference.

  • You’ll receive the module ID “loResources” part in response physique:

Pattern payload for userModuleGrade API:

{
“knowledge”: {
“kind”: “userModuleGrade”,
“attributes”: {
“period”: 1,
“rating”: 20,
“minScore”: 10,
“maxScore”: 20,
“dateCompleted”: “2023-09-20T09:36:36.000Z”,
“dateSuccess”: “2023-09-20T09:36:36.000Z”,
“dateStarted”: “2023-09-19T09:35:57.000Z”,
“began”: true,
“accomplished”: true,
“success”: true
},
“relationships” : {
“learner” : {
“knowledge” : [
{
“id”:”13230830″,
“type”: “user”
}
]
},
“module” : {
“knowledge” : [
{
“id”:”7968486132104870″,
“type”: “courseModule”
}
]
},
“course” : {
“knowledge” : [
{
“id”:”7968486″,
“type”: “course”
}
]
}
}
}
}

Fundamental Navigation steps for reference:

Step 1: Login as integration admin of the ALM account > Developer Assets > API References

Step 2: Authorize admin learn and write.

Step 3: Navigate to APIs you wish to execute as shared in earlier steps

Oh hi there 👋
It’s nice to meet you.

Sign up to receive awesome content in your inbox, every month.

We don’t spam! Read our [link]privacy policy[/link] for more info.

Related Articles

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Latest Articles