Fetch Module Sessions API

This API is used for fetching session in modules of batches in LMS

Request URL: (Blended Learning Course)

http://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/modules/<moduleId>/sessions

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

JavaScript Curl Deluge Python

Copiedconst url = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/modules/478346000019479119/sessions?startIndex=3";

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/sessions?startIndex=3" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"

Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/modules/478346000019479119/sessions?startIndex=3";

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/sessions?startIndex=3"

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.9b8xxxxxxf

Response

Copied{
    "sessions": [
        {
            "totalLearnersCount": 0,
            "sessionName": "Session One",
            "sessionEndTime": "1:00 PM",
            "sessionStartTime": "11:00 AM",
            "description": "Description for Session",
            "resources": [],
            "sessionId": "219225000000645227",
            "roomId": "219225000000645249",
            "canUserDelete": false,
            "sessionStartDate": "11-01-2022",
            "lockUntil": "",
            "presentLeanersCount": 0,
            "gradeCategoryName": "",
            "isLocked": false,
            "gradeCategoryId": "",
            "sessionType": "Classroom",
            "sessionRoom": "Room One",
            "sessionTrainer": "Henry",
            "isSessionCompleted": false,
            "trainerErecno": "219225000000036453",
            "canUserEdit": false,
            "moduleId": "219225000000645219"
        }
    ],
    "code": 200,
    "message": "success",
    "hasMoreRecords": false
}

Show full

Show less