List Requisite Course Entities API
The purpose of the API is to list the course entities that are required to be completed in order to unlock the current course entity.
Request URL:
http://people.zoho.com/api/v1/courses/{Course ID}/batches/{Batch ID}/learners/{Learner ID}/lockedEntities/{Locked Entity ID}
Note: Batch id will be '0' if it is a self paced learning.
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ
Possible Operation Types:
ALL - Complete access to data
READ - Only to read data
Method:
GET
Error Codes and Descriptions
| Status Codes | Description |
|---|---|
| 400 | Invalid parameter value/input parameter missing |
| 403 | Sorry! You are not authorized to do this operation |
| 404 | Not found |
| 422 | Maximum limit exceeded |
| 500 | Sorry! Server error occured |
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.
Request:
CopiedOkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("http://people.zoho.com/api/v1/courses/101685000001935205/batches/101685000001935217/learners/101685000000170005/lockedEntities/101685000001935229")
.get()
.addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());Copiedfetch("http://people.zoho.com/api/v1/courses/101685000001935205/batches/101685000001935217/learners/101685000000170005/lockedEntities/101685000001935229", {
method: "GET",
headers: {
"Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf"
}
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));Copiedcurl --location --request GET 'http://people.zoho.com/api/v1/courses/101685000001935205/batches/101685000001935217/learners/101685000000170005/lockedEntities/101685000001935229' \
--header 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf'Copiedtry
{
response = invokeUrl
[
url: "http://people.zoho.com/api/v1/courses/101685000001935205/batches/101685000001935217/learners/101685000000170005/lockedEntities/101685000001935229"
type: GET
headers: map("Authorization" -> "Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf")
];
}
catch(e)
{
info "Exception while making the API request.";
}Copiedimport requests
url = "http://people.zoho.com/api/v1/courses/101685000001935205/batches/101685000001935217/learners/101685000000170005/lockedEntities/101685000001935229"
headers = {
"Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf"
}
response = requests.get(url, headers=headers)
print(response.text)Show full
Show less
Header:
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse:
Copied{
"code": 200,
"lockedEntities": [
{
"lockedEntityName": "l1",
"lockedEntityId": "101685000001935239",
"lockedEntityType": "3"
}
],
"message": "success"
}