Single Learner - All Course Progress | LMS

Single Learner - All Course Progress

This API provides the progress of a individual learner in all the courses that he has enrolled in.

Request URL:

https://people.zoho.com/api/v1/learners/<learnerId>/course-progress

Possible Operation Types:

READ - Only to read data

Request Parameters

Parameters	Values Allowed	Default Value	Description	Mandatory
startIndex	Integer	0	starting index	No

View complete list of LMS API error codes

Threshold Limit: 30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

REQUESTS

Java JavaScript Curl Deluge Python

Copiedimport okhttp3.*;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/learners/100002000000041342/course-progress")
            .get()
            .addHeader("Authorization", "Zoho-oauthtoken <your_access_token>")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

Copiedfetch("https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/learners/100002000000041342/course-progress", {
  method: "GET",
  headers: {
    "Authorization": "Zoho-oauthtoken <your_access_token>"
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Copiedcurl --request GET \
  --url "https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/learners/100002000000041342/course-progress" \
  --header "Authorization: Zoho-oauthtoken <your_access_token>"

Copiedurl = "https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/learners/100002000000041342/course-progress";
headers = map();
headers.put("Authorization","Zoho-oauthtoken <your_access_token>");
response = getUrl(url, headers);
info response;

Copiedimport requests

url = "https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/learners/100002000000041342/course-progress"
headers = {
    "Authorization": "Zoho-oauthtoken <your_access_token>"
}

response = requests.get(url, headers=headers)
print(response.json())

HEADER

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

SAMPLE REQUEST

Copiedhttps://people.zoho.com/api/v1/learners/190801059/course-progress

SAMPLE RESPONSE

Copied{
   "courseProgress": [
       {
           "batchName": "Batch 1",
           "courseType": "Blended learning",
           "totalEntitiesCount": 4,
           "enrolledDate": "03-Aug-2023",
           "batchId": 100004000000045013,
           "type": 2,
           "completedIn": "1 days",
           "completedEntitiesCount": 1,
           "completionPercentage": 25,
           "courseName": "Blended Learning7!@#$%^&()--+=;;:\"',.?/|\\{}[]",
           "managerEvaluationTotalMarks": "",
           "managerEvaluationMarks": "",
           "completionDate": "",
           "completionStatus": "In progress",
           "courseId": 100004000000045001
       },

       {
           "batchName": "",
           "courseType": "Self paced learning",
           "totalEntitiesCount": 2,
           "enrolledDate": "01-Aug-2023",
           "batchId": "",
           "type": 1,
           "completedIn": "",
           "completedEntitiesCount": 0,
           "completionPercentage": 0,
           "courseName": "Hello",
           "managerEvaluationTotalMarks": "95",
           "managerEvaluationMarks": "100",
           "completionDate": "",
           "completionStatus": "In progress",
           "courseId": 100004000000036814
       }
   ],

   "code": 200,
   "learnerId": "100004000000036860",
   "learnerName": "Harvey spector",
   "learnerImageURL": "https://contacts.csez.zohocorpin.com/file?ID=16619869&fs=thumb",
   "hasMoreRecords": false,
   "status": "success"
}