Fetch Single File API
This API is used for fetching file details in LMS
Request URL: (Self Paced Course)
https://people.zoho.com/api/v1/courses/<courseId>/modules/<moduleId>/files/<fileId>
Request URL: (Blended Learning Course)
https://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules/<moduleId>/files/<fileId>
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ
Possible Operation Types:
ALL - Complete access to data
READ - Only to fetch 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 (Self Paced)
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/478346000019007001/modules/478346000019007013/files/478346000019582003")
.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/478346000019007001/modules/478346000019007013/files/478346000019582003";
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/478346000019007001/modules/478346000019007013/files/478346000019582003" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019007001/modules/478346000019007013/files/478346000019582003";
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/478346000019007001/modules/478346000019007013/files/478346000019582003"
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,
"file": {
"isMandatoryFile": true,
"fileName": "File One",
"previewURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1631&x-cli-msg=%7B%22mode%22%3A%22LMS%22%2C%22portalId%22%3A%2226484356%22%2C%22isInline%22%3Atrue%2C%22isThumbnail%22%3Afalse%2C%22type%22%3A1%2C%22fileId%22%3A219225000000645181%7D",
"canMarkAsComplete": 0,
"description": "About the file",
"resources": [
{
"resourceURL": "https://downloadcc-accl.zoho.com/webdownload?x-service=people&event-id=104689001_ZPEOPLE_LMS_1632&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%3A219225000000645191%7D",
"resourceName": "resource.png"
}
],
"canUserDelete": true,
"duration": "45 Mins",
"lockUntil": "29-12-2021",
"isDownloadable": true,
"isIntroFile": true,
"isLocked": true,
"canUserEdit": true,
"moduleId": "219225000000648001",
"fileId": "219225000000645181"
},
"message": "success"
}Show full
Show less