Unenroll Learner From Batch API
This API is used to unenroll learner from a batch in LMS.
Request URL:
http://people.zoho.com/api/v1/courses/<courseId>/batches/<batchId>/unenroll?erecnosList=<erecnosList>
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.CREATE
Possible Operation Types:
ALL - Complete access to data
CREATE - Only to create data
Method:
POST
Request Parameters
| Parameters | Values Allowed | Default Value | Description |
| *erecnosList | <parameters in JSONArray> | <Mandatory> | Specify the employee erec no's |
*mandatory parameters
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/unenroll?learnerErecno=478346000000248165")
.post(RequestBody.create(null, new byte[0]))
.addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}Copiedfetch("https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/unenroll?learnerErecno=478346000000248165", {
method: "POST",
headers: {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error(error));Copiedcurl --location --request POST 'https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/unenroll?learnerErecno=478346000000248165' \
--header 'Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN'Copiedurl = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/unenroll?learnerErecno=478346000000248165";
headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
response = invokeurl
[
url : url
type : POST
headers: headers
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/v1/courses/478346000019479103/batches/478346000019479115/unenroll?learnerErecno=478346000000248165"
headers = {
"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}
response = requests.post(url, headers=headers)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfResponse
Copied{
"code": "200",
"learners": [
{
"erecno": "219225000000185023",
"learnerId": "219225000000653009",
"enrollmentStatus": "unenrolled",
"batchId": "219225000000645203",
"courseId": "219225000000645203"
}
],
"message": "success"
}