Fetch Course or Batch Links API
This API is used for fetching links in courses or batches of LMS.
Request URL: (Self Paced Course)
https://people.zoho.com/api/v1/courses/<courseId>/links
Request URL: (Blender Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/links
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 | <parameters in JSON Object> | JSON Input |
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();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://people.zoho.com/api/v1/courses/478346000019479001/links")
.newBuilder();
urlBuilder.addQueryParameter("startIndex", "0");
Request request = new Request.Builder()
.url(urlBuilder.build().toString())
.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/478346000019479001/links?startIndex=0";
fetch(url, {
method: "GET",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error("Error:", error));Copiedcurl -X GET "https://people.zoho.com/api/v1/courses/478346000019479001/links?startIndex=0" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019479001/links?startIndex=0";
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/478346000019479001/links"
params = {"startIndex": "0"}
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
response = requests.get(url, headers=headers, params=params)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
Copied{
"code": 200,
"links": [
{
"lockUntil": "23-12-2021",
"linkId": "219225000000645001",
"isMandatoryLink": true,
"canMarkAsComplete": 0,
"isLocked": true,
"link": "http://zoho.com/people",
"description": "Description for Link",
"resources": [
{
"resourceURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1571&x-cli-msg=%7B%22mode%22%3A%22LMS%22%2C%22portalId%22%3A%2226484356%22%2C%22isInline%22%3Afalse%2C%22isThumbnail%22%3Afalse%2C%22type%22%3A2%2C%22fileId%22%3A219225000000645013%7D",
"resourceName": "resource.png"
}
],
"canUserEdit": true,
"moduleId": "219225000000642014",
"linkName": "Link One",
"canUserDelete": true
},
{
"lockUntil": "22-12-2021",
"linkId": "219225000000645025",
"isMandatoryLink": true,
"canMarkAsComplete": 0,
"isLocked": true,
"link": "http://zoho.com/people",
"description": "Description for Link",
"resources": [
{
"resourceURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1572&x-cli-msg=%7B%22mode%22%3A%22LMS%22%2C%22portalId%22%3A%2226484356%22%2C%22isInline%22%3Afalse%2C%22isThumbnail%22%3Afalse%2C%22type%22%3A2%2C%22fileId%22%3A219225000000645035%7D",
"resourceName": "resource.png"
}
],
"canUserEdit": true,
"moduleId": "219225000000648001",
"linkName": "Link Two",
"canUserDelete": true
}
],
"message": "success",
"hasMoreRecords": false
}Show full
Show less