Get Enroll Batch Details
Returns one of the learner's enrolled batches: each class (subject) in it with the learner's progress and rank, plus batch and course details. Use it to build a learner's "my course" page.
GET
/student/masterbatches/classes/{master_batch_id}Get Enroll Batch Details
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/student/masterbatches/classes/{master_batch_id}?show_overview=1'{
"courses": [
{
"archived": 0,
"category": 3,
"class_id": 858,
"class_name": "Physics For IIT",
"course_id": 23,
"course_name": "Physics For IIT",
"class_end_date": 1559260800,
"organization_id": 2,
"resource_only_course": 0,
"class_start_date": 1556668800,
"status": "live",
"tutor_id": 1,
"tutor_name": " Gaurav Kapoor",
"tutor_username": "harshit",
"img_url": "https://d15g8b7hr8be7w.cloudfront.net/User(1)/108026-Screenshot_from_2022-04-28_14-39-00.png",
"name": "Physics For IIT",
"num_of_sections": "",
"total_assignments": "",
"assignment_completed": "",
"stats": {
"class_id": "858",
"class_name": "Physics For IIT",
"course_num_exercises": "50",
"course_num_quizzes": "12",
"course_num_assignments": "7",
"course_num_materials": "71",
"course_num_sections": "29",
"total_items": "140",
"user_uattempts": "0",
"user_passed": "0",
"user_usubmissions": "0",
"user_mat_uviews": "0",
"user_uattempts_quiz": "0",
"user_passed_quiz": "0",
"student_name": "FreePreview",
"student_username": "FreePreview7414424",
"num_students": "7",
"c_attempts": "0",
"avg_grade": 0,
"user_attempts": "0",
"user_perfect": "0",
"class_progress": 0,
"rank": "1",
"rank_ties": 3
}
},
{
"archived": 0,
"category": 3,
"class_id": 859,
"class_name": "Mathematics for IIT-JEE ",
"course_id": 82,
"course_name": "Mathematics for IIT-JEE ",
"class_end_date": 1559260800,
"organization_id": 2,
"resource_only_course": 0,
"class_start_date": 1556668800,
"status": "live",
"tutor_id": 15,
"tutor_name": "Saurav Shandilya1",
"tutor_username": "h2",
"img_url": "",
"name": "Mathematics for IIT-JEE ",
"num_of_sections": "",
"total_assignments": "",
"assignment_completed": "",
"stats": {
"class_id": "859",
"class_name": "Mathematics for IIT-JEE ",
"course_num_exercises": "3",
"course_num_quizzes": "0",
"course_num_assignments": "0",
"course_num_materials": "4",
"course_num_sections": "1",
"total_items": "7",
"user_uattempts": "0",
"user_passed": "0",
"user_usubmissions": "0",
"user_mat_uviews": "0",
"user_uattempts_quiz": "0",
"user_passed_quiz": "0",
"student_name": "FreePreview",
"student_username": "FreePreview7414424",
"num_students": "7",
"c_attempts": "0",
"avg_grade": 0,
"user_attempts": "0",
"user_perfect": "0",
"class_progress": 0,
"rank": null,
"rank_ties": -1
}
},
{
"archived": 0,
"category": 3,
"class_id": 860,
"class_name": "Feb-Course",
"course_id": 230,
"course_name": "Feb-Course",
"class_end_date": 1559260800,
"organization_id": 2,
"resource_only_course": 0,
"class_start_date": 1556668800,
"status": "live",
"tutor_id": 1,
"tutor_name": " Gaurav Kapoor",
"tutor_username": "harshit",
"img_url": "https://d15g8b7hr8be7w.cloudfront.net/User(1)/108026-Screenshot_from_2022-04-28_14-39-00.png",
"name": "Feb-Course",
"num_of_sections": "",
"total_assignments": "",
"assignment_completed": "",
"stats": {
"class_id": "860",
"class_name": "Feb-Course",
"course_num_exercises": "3",
"course_num_quizzes": "0",
"course_num_assignments": "0",
"course_num_materials": "3",
"course_num_sections": "2",
"total_items": "6",
"user_uattempts": "0",
"user_passed": "0",
"user_usubmissions": "0",
"user_mat_uviews": "0",
"user_uattempts_quiz": "0",
"user_passed_quiz": "0",
"student_name": "FreePreview",
"student_username": "FreePreview7414424",
"num_students": "7",
"c_attempts": "0",
"avg_grade": 0,
"user_attempts": "0",
"user_perfect": "0",
"class_progress": 0,
"rank": null,
"rank_ties": -1
}
}
],
"code": 200,
"message": "Success",
"master_batch_details": {
"master_batch_name": "May-04-2019",
"master_batch_id": 704,
"mb_start_date": 1556668800,
"mb_end_date": 1559260800,
"mb_tutor_id": 1,
"mb_tutor_name": " Gaurav Kapoor",
"mb_tutor_username": "harshit",
"free_preview_allowed": 0,
"payment_id": null,
"institution_bundle_id": 7,
"organization_id": 2,
"allow_student_unenrolling": 0,
"allow_curriculum_access_after_completed": 0,
"allow_student_mark_batch_completed": 0,
"mb_status": 0,
"accepted": null,
"status": null,
"bundle_id": 7,
"pretty_name": "CET",
"tutor_img": "https://d15g8b7hr8be7w.cloudfront.net/User(1)/108026-Screenshot_from_2022-04-28_14-39-00.png",
"bundle_image_url": "",
"progress": 0,
"num_materials": 78,
"num_exercises": 56,
"user_uviews": 0,
"user_passed": 0,
"user_uattempts": 0,
"avg_grade": 0,
"avg_rank": 1,
"bundle_overview": ""
},
"masterbatch_pending": [],
"free_preview_masterbatch": [
1235
]
}Access: Learners, for batches they are enrolled in (or previewing).
Path parameters
The batch ID, as the last URL segment.
Query parameters
get_tagsinteger
1 adds tags, the course's tag categories.show_overviewinteger
1 adds master_batch_details.bundle_overview (HTML).Response
coursesobject[]
One entry per active or completed class in the batch
Show child attributesHide child attributes
courses.archivedinteger
Example:
0courses.categoryinteger
Example:
3courses.class_idinteger
Example:
858courses.class_namestring
Example:
Physics For IITcourses.course_idinteger
Example:
23courses.organization_idinteger
Example:
2courses.resource_only_courseinteger
Example:
0courses.class_start_dateinteger
Example:
1556668800courses.tutor_idinteger
Example:
1courses.tutor_namestring
Example:
Gaurav Kapoorcourses.tutor_usernamestring
Example:
harshitcourses.img_urlstring
courses.namestring
Example:
Physics For IITcourses.num_of_sectionsstring
courses.statsobject
Show child attributesHide child attributes
courses.stats.class_idstring
Example:
858courses.stats.class_namestring
Example:
Physics For IITExample:
50Example:
12Example:
7Example:
71Example:
29Example:
140Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
FreePreviewExample:
FreePreview7414424Example:
7courses.stats.c_attemptsstring
Example:
0courses.stats.avg_gradeinteger
Example:
0Example:
0Example:
0courses.stats.rankstring
Example:
1courses.stats.rank_tiesinteger
Example:
3codeinteger
Example:
200messagestring
Example:
Successmaster_batch_detailsobject
Show child attributesHide child attributes
Example:
May-04-2019Example:
704Example:
1556668800Example:
1559260800Example:
1Example:
Gaurav KapoorExample:
harshitExample:
0Example:
7Example:
2Example:
0Example:
0Example:
0Example:
0draft/liveExample:
7Example:
CETExample:
78Example:
56Example:
0Example:
0Example:
0Example:
0Example:
1masterbatch_pendingarray
free_preview_masterbatchinteger[]
Notes: If the learner has no access to the batch, the call fails with "You do not have access to this course or batch.". Calling it also marks the batch as the learner's most recently opened one, which moves it to the top of "Student Enroll Batches". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.