Docs home

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}/resources
Get 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
class_idintegerrequired
The class ID (from the batch's classes), as the number in the URL.
Query parameters
1 returns each section as a JSON object. 2 (default) returns each section as a positional array.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
sectionsobject[]
Published sections in display order
Show child attributesHide child attributes
Example: 178109
Example: Section A
Example: 3
Example: 19
Example: 0
Example: 0
Example: 0
Example: 0
Example: 0
Materials viewed
Example: 2
Percent
Example: 9
Example: 1
Example: 0
Unix timestamps, 0 if not set
Example: 0
Example: 0
Example: 0
assignmentsinteger[][]
Always positional arrays
classobject
Class and tutor details
Show child attributesHide child attributes
Example: 182884
Example: 40450
Example: sample
Example: 212
Example: 3846680
Example: Edmingle Admin
Example: demoadmin
Example: sample
Example: 1
Example: 3
Example: 44840
Example: sample
Example: sample
Example: 44840
Example: 0
Learner's counts as strings, rank, rank_ties, class_progress percent
Show child attributesHide child attributes
Example: 182884
Example: sample
Example: 35
Example: 0
Materials viewed
Example: 2
Example: Asit Update
Example: Asit9679054
Example: 21
Example: 26
Example: 0
Example: 0
Example: 7
Example: 0

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.

Updated yesterday

Ask AI