Get Class Details
Returns the sections of one class (subject) in the learner's batch, with the learner's progress in each, plus assignments, class details and stats. Use it to build the learner's subject page.
GET
/student/classcurriculum/{ClassId}/resourcesGet Class Details
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/student/classcurriculum/{ClassId}/resources?response_type=1' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"sections": [
{
"id": 178109,
"name": "Section A",
"num_exercises": 3,
"num_materials": 19,
"avg_grade": 0,
"user_uattempts": 0,
"user_attempts": 0,
"user_passed": 0,
"user_perfect": 0,
"user_mat_uviews": 2,
"total_progress": 9,
"availability": 1,
"activate_at": 0,
"deactivate_at": 0,
"freepreview": 0,
"description": "",
"is_prerequisite": 0
},
{
"id": 311152,
"name": "Module 1",
"num_exercises": 1,
"num_materials": 1,
"avg_grade": 0,
"user_uattempts": 0,
"user_attempts": 0,
"user_passed": 0,
"user_perfect": 0,
"user_mat_uviews": 0,
"total_progress": 0,
"availability": 1,
"activate_at": 0,
"deactivate_at": 0,
"freepreview": 0,
"description": "",
"is_prerequisite": 1
},
{
"id": 197527,
"name": "new",
"num_exercises": 0,
"num_materials": 5,
"avg_grade": 0,
"user_uattempts": 0,
"user_attempts": 0,
"user_passed": 0,
"user_perfect": 0,
"user_mat_uviews": 0,
"total_progress": 0,
"availability": 1,
"activate_at": 0,
"deactivate_at": 0,
"freepreview": 0,
"description": "",
"is_prerequisite": 0
},
{
"id": 314617,
"name": "test 2.0",
"num_exercises": 0,
"num_materials": 2,
"avg_grade": 0,
"user_uattempts": 0,
"user_attempts": 0,
"user_passed": 0,
"user_perfect": 0,
"user_mat_uviews": 0,
"total_progress": 0,
"availability": 1,
"activate_at": 0,
"deactivate_at": 0,
"freepreview": 0,
"description": "",
"is_prerequisite": 0
}
],
"assignments": [
[
367,
"jkwefe",
0,
1,
0,
0,
0,
0
],
[
420,
"Assi 1",
0,
1,
0,
0,
0,
0
]
],
"class": {
"class_id": 182884,
"course_id": 40450,
"class_name": "sample",
"organization_id": 212,
"tutor_id": 3846680,
"tutor_name": "Edmingle Admin",
"tutor_username": "demoadmin",
"course_name": "sample",
"status": 1,
"category": 3,
"resource_only_course": 0,
"free_preview_allowed": 0,
"institution_bundle_id": 44840,
"pretty_name": "sample",
"mb_pretty_name": "sample",
"mb_institution_bundle_id": 44840,
"is_woolf_accredited": 0,
"stats": {
"class_id": "182884",
"class_name": "sample",
"course_num_exercises": "4",
"course_num_quizzes": "2",
"course_num_assignments": "2",
"course_num_materials": "27",
"course_num_sections": "4",
"total_items": "35",
"user_uattempts": "0",
"user_passed": "0",
"user_usubmissions": "0",
"user_mat_uviews": "2",
"user_uattempts_quiz": "0",
"user_passed_quiz": "0",
"student_name": "Asit Update",
"student_username": "Asit9679054",
"num_students": "21",
"c_attempts": "26",
"user_attempts": "0",
"user_perfect": "0",
"avg_grade": "0",
"rank": "7",
"rank_ties": 0,
"class_progress": 6
}
},
"courses_payments_pending": [],
"courses_payment_ids": [],
"free_preview_courses": [],
"free_preview_courses_payments": []
}Access: Learners enrolled in the class.
Path parameters
The class ID (from the batch's classes), as the number in the URL.
Query parameters
response_typeinteger
1 returns each section as a JSON object. 2 (default) returns each section as a positional array.Response
codeinteger
Example:
200messagestring
Example:
Successsectionsobject[]
Published sections in display order
Show child attributesHide child attributes
sections.idinteger
Example:
178109sections.namestring
Example:
Section Asections.num_exercisesinteger
Example:
3sections.num_materialsinteger
Example:
19sections.avg_gradeinteger
Example:
0sections.user_uattemptsinteger
Example:
0sections.user_attemptsinteger
Example:
0sections.user_passedinteger
Example:
0sections.user_perfectinteger
Example:
0sections.availabilityinteger
Example:
1sections.activate_atinteger
Example:
0sections.freepreviewinteger
Example:
0sections.descriptionstring
sections.is_prerequisiteinteger
Example:
0assignmentsinteger[][]
Always positional arrays
classobject
Class and tutor details
Show child attributesHide child attributes
class.class_idinteger
Example:
182884class.course_idinteger
Example:
40450class.class_namestring
Example:
sampleclass.organization_idinteger
Example:
212class.tutor_idinteger
Example:
3846680class.tutor_namestring
Example:
Edmingle Adminclass.tutor_usernamestring
Example:
demoadminclass.course_namestring
Example:
sampleclass.statusinteger
Example:
1class.categoryinteger
Example:
3class.resource_only_courseinteger
Example:
0class.free_preview_allowedinteger
Example:
0class.institution_bundle_idinteger
Example:
44840class.pretty_namestring
Example:
sampleclass.mb_pretty_namestring
Example:
sampleExample:
44840class.is_woolf_accreditedinteger
Example:
0class.statsobject
Learner's counts as strings,
rank, rank_ties, class_progress percentShow child attributesHide child attributes
class.stats.class_idstring
Example:
182884class.stats.class_namestring
Example:
sampleExample:
4Example:
2Example:
2Example:
27Example:
4class.stats.total_itemsstring
Example:
35Example:
0class.stats.user_passedstring
Example:
0Example:
0Example:
0Example:
0class.stats.student_namestring
Example:
Asit UpdateExample:
Asit9679054class.stats.num_studentsstring
Example:
21class.stats.c_attemptsstring
Example:
26Example:
0class.stats.user_perfectstring
Example:
0class.stats.avg_gradestring
Example:
0class.stats.rankstring
Example:
7class.stats.rank_tiesinteger
Example:
0class.stats.class_progressinteger
Example:
6courses_payment_idsarray
free_preview_coursesarray
Notes: A class the learner has no access to returns "You do not have access to this class". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.