Single Learner - Single Course Progress API

Single Learner - Single Course Progress

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

Request URL:

https://people.zoho.com/api/v1/courses/<courseId>/(batches/<batchId>/)learners/<learnerId>/course-progress

Possible Operation Types:

READ - Only to read data

Request Parameters

Parameters	Values Allowed	Default Value	Description	Mandatory
progressType	0\|1	0	0 --> For all entities 1 --> For Mandatory entities	No
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/courses/100002000000039001/batches/100002000000041383/learners/100002000000041342/course-progress

SAMPLE RESPONSE

Copied{
   "courseProgress": {
       "batchName": "",
       "courseType": "Self paced learning",
       "totalEntitiesCount": 2,
       "enrolledDate": "01-Aug-2023",
       "learnerName": "Harvey spector",
       "batchId": "",
       "type": 1,
       "completedIn": "",
       "learnerName": "Harvey spector",
       "learnerImageURL": "https://contacts.csez.zohocorpin.com/file?ID=16619869&fs=thumb",
       "completedEntitiesCount": 0,
       "progressActivities": {
           "moduleActivities": {
               "completePercentage": 0,
               "progressColor": "#26abf1",
               "completedEntities": 0,
               "totalEntities": 2
           }
       },

       "completionPercentage": 0,
       "courseName": "Hello",
       "managerEvaluationTotalMarks": 
       "learnerId": "100004000000036860",
       "managerEvaluationMarks": "",
       "completionDate": "",
       "completionStatus": "In progress",
       "courseId": 100004000000036814
   },

   "code": 200,
   "status": "success"
}