Fetch Module Online Tests API
This API is used for fetching online tests in modules of course/batches in LMS
Request URL: (Self Paced Course)
https://people.zoho.com/api/v1/courses/<courseId>/modules/<moduleId>/onlineTests
Request URL: (Blended Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules/<moduleId>/onlineTests
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ
Possible Operation Types:
ALL - Complete access to data
READ - Only to fetch data
Method:
GET
Request Parameters
| Parameters | Values Allowed | Default Value | Description |
| *startIndex | <integer> | 0 | Specify from which record the response should be fetched |
Note: Upto 25 records can be fetched in single API call
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
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/478346000019479103/batches/478346000019479115/modules/478346000019479119/onlineTests")
.get()
.addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}Copiedconst url = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/modules/478346000019479119/onlineTests";
fetch(url, {
method: "GET",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
})
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));Copiedcurl -X GET "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/modules/478346000019479119/onlineTests" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/modules/478346000019479119/onlineTests";
headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
response = invokeurl
[
url : url
type : GET
headers: headers
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/modules/478346000019479119/onlineTests"
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
Copied{
"code": 200,
"onlineTests": [
{
"previewURL": "https://people.zoho.com/peoplelms/assessments/219225000000645085/preview",
"showMarksToLearner": "Yes",
"totalLearnersCount": 0,
"resources": [],
"canUserDelete": true,
"duration": "35 Mins",
"isMandatoryTest": true,
"lockUntil": "",
"gradeCategoryName": "",
"completedLearnersCount": 0,
"isLocked": false,
"maximumAttemptsAllowed": 5,
"testId": "219225000000645077",
"canUserEdit": true,
"moduleId": "219225000000648001",
"testMark": "1.0",
"testName": "Online Test One",
"status": "Not ready"
}
],
"message": "success",
"hasMoreRecords": false
}Show full
Show less