Docs home

List of Batch Class

Returns the sessions of one class (subject batch) with each student's attendance. Use it to build attendance reports or to find the `attendance_id` of a session before editing, cancelling or marking it.

GET/class/attendance
List of Batch Class
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/class/attendance?class_id=1941&start=1656613800&end=1659292199&dataLoaded=true' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "payload": {
        "attendance": [
            [
                24527,
                15,
                "Saurav Shandilya1",
                1656613800,
                300,
                540,
                0,
                -1,
                15,
                "Saurav Shandilya1",
                "Drip testing",
                1941,
                6,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        49,
                        "Demo Student ",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "8660740295",
                        "708",
                        "",
                        2,
                        "abhiss@edmingle.com"
                    ],
                    [
                        33903,
                        "Email Test",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        null,
                        "1652",
                        "",
                        2,
                        "nogecep473@itwbuy.com"
                    ],
                    [
                        2,
                        "John10 wick",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9963652858",
                        "2",
                        "",
                        2,
                        "joherenwick@edmingle.com"
                    ],
                    [
                        34507,
                        "Rahul",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "7894561237",
                        "1516",
                        "",
                        2,
                        "rahul@gmail.com"
                    ],
                    [
                        34473,
                        "raksha",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9874563214",
                        "1509",
                        "",
                        2,
                        "raksha@gmail.com"
                    ],
                    [
                        382,
                        "ram prasad",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9906577667",
                        "25",
                        "",
                        2,
                        "ramp409@gmail.com"
                    ],
                    [
                        34501,
                        "Ravi",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9113386951",
                        "1515",
                        "",
                        2,
                        "ravi@gmail.com"
                    ],
                    [
                        463,
                        "Test",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9669698989",
                        "716",
                        "",
                        2,
                        "testfree11@edmingle.com"
                    ],
                    [
                        413,
                        "Test 977",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9779000000",
                        "28",
                        "",
                        2,
                        "test977@edmingle.com"
                    ]
                ],
                9,
                2,
                "Dmeo Reshedulce",
                "",
                "",
                "",
                0,
                15,
                "Saurav Shandilya1",
                1656613800,
                300,
                540,
                0,
                1,
                0,
                1153,
                "Drip testing",
                0,
                "",
                1,
                0
            ],
            [
                22856,
                15,
                "Saurav Shandilya1",
                1656613800,
                660,
                720,
                3,
                1658154740,
                62,
                "Sanjay",
                "Drip testing",
                1941,
                6,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        49,
                        "Demo Student ",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "8660740295",
                        "708",
                        "",
                        2,
                        "abhiss@edmingle.com"
                    ],
                    [
                        33903,
                        "Email Test",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        null,
                        "1652",
                        "",
                        2,
                        "nogecep473@itwbuy.com"
                    ],
                    [
                        2,
                        "John10 wick",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9963652858",
                        "2",
                        "",
                        2,
                        "joherenwick@edmingle.com"
                    ],
                    [
                        34507,
                        "Rahul",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "7894561237",
                        "1516",
                        "",
                        2,
                        "rahul@gmail.com"
                    ],
                    [
                        34473,
                        "raksha",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9874563214",
                        "1509",
                        "",
                        2,
                        "raksha@gmail.com"
                    ],
                    [
                        382,
                        "ram prasad",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9906577667",
                        "25",
                        "",
                        2,
                        "ramp409@gmail.com"
                    ],
                    [
                        34501,
                        "Ravi",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9113386951",
                        "1515",
                        "",
                        2,
                        "ravi@gmail.com"
                    ],
                    [
                        463,
                        "Test",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9669698989",
                        "716",
                        "",
                        2,
                        "testfree11@edmingle.com"
                    ],
                    [
                        413,
                        "Test 977",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9779000000",
                        "28",
                        "",
                        2,
                        "test977@edmingle.com"
                    ]
                ],
                9,
                0,
                "",
                "",
                "",
                "",
                0,
                62,
                "Saurav Shandilya1",
                1656613800,
                660,
                720,
                0,
                1,
                0,
                1153,
                "Drip testing",
                0,
                null,
                1,
                0
            ],
            [
                22857,
                15,
                "Saurav Shandilya1",
                1656700200,
                660,
                720,
                0,
                -1,
                62,
                "Sanjay",
                "Drip testing",
                1941,
                6,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        49,
                        "Demo Student ",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "8660740295",
                        "708",
                        "",
                        2,
                        "abhiss@edmingle.com"
                    ],
                    [
                        33903,
                        "Email Test",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        null,
                        "1652",
                        "",
                        2,
                        "nogecep473@itwbuy.com"
                    ],
                    [
                        2,
                        "John10 wick",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9963652858",
                        "2",
                        "",
                        2,
                        "joherenwick@edmingle.com"
                    ],
                    [
                        34507,
                        "Rahul",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "7894561237",
                        "1516",
                        "",
                        2,
                        "rahul@gmail.com"
                    ],
                    [
                        34473,
                        "raksha",
                        5,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9874563214",
                        "1509",
                        "",
                        2,
                        "raksha@gmail.com"
                    ],
                    [
                        382,
                        "ram prasad",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9906577667",
                        "25",
                        "",
                        2,
                        "ramp409@gmail.com"
                    ],
                    [
                        34501,
                        "Ravi",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9113386951",
                        "1515",
                        "",
                        2,
                        "ravi@gmail.com"
                    ],
                    [
                        463,
                        "Test",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9669698989",
                        "716",
                        "",
                        2,
                        "testfree11@edmingle.com"
                    ],
                    [
                        413,
                        "Test 977",
                        -1,
                        "",
                        0,
                        -1,
                        0,
    

Access: Institute admins and tutors who can access the class, students enrolled in it, and custom roles that can view attendance reports. Students only see their own attendance.

Query parameters
class_idintegerrequired
The class.
startUnix timestamp
With end: only sessions starting at or after this time.
endUnix timestamp
With start: only sessions starting before this time. Without start and end, sessions up to today are returned.
user_idinteger
Only this student's attendance.
pageinteger
Send with per_page to get one page of sessions, newest first. Without both, all sessions come back, oldest first.
per_pageinteger
Sessions per page, when paging.
1 returns sessions and students as objects with named fields. Leave it out to get arrays without keys, in the field order below.
1 adds payload.certificates_awarded: for each student (userID), how many certificates they have been awarded.
Purpose unclear from code (affects how archived students are counted).

Response: payload.attendance is a list of sessions. Each session has, in this order: id (the attendance_id), taken_by, taken_by_name, class_date (Unix timestamp), start_time and end_time (minutes after midnight), status (session status: 0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in, 6 Excused, 7 Absent), taken_at, signin_by, signin_by_name, class_name, class_id, total_students, present, admin_data (canChangeTime, canChangeDate, pay), student_data, not_marked, class_type (0 Normal, 1 Exam, 2 Extra, 3 Batch-level, 4 Event, 5 Mentoring), topics_taught, pages_taught, homework, topics_taught_ids, signout_at, signout_by, signout_by_name, teacher_class_date, teacher_start_time, teacher_end_time, signout_status, is_live (0 Offline, 1 Live not started, 2 Running, 3 Ended), zoom_room_waiting, master_batch_id, master_batch_name, individual_batch_attendance, external_class_link, virtual_class_type (0 Offline, 1 Zoom Meeting, 5 Zoom Webinar, 6 Custom Link, 8 MS Teams), is_free_enrolment, master_batches, is_sharable_link_enabled, can_join_without_login, joining_link, feedback_form_id, is_woolf_session, organization_id, woolf_resource_id, is_nonmandatory_session, session_duration (seconds).

Each student_data entry has, in order: studentId, name, status (-1 Not marked yet, 0 Absent, 1 Present, 2 Late, 3 Excused, 4 Leave, 5 Not applicable), remarks, the student's and parent's session feedback (user_status, user_status_time, user_rating, user_comments, parent_id, parent_name, parent_status, parent_status_time, parent_rating, parent_comments), img_url, user_state, contact_number, reg_id, p_img_url, org_status, email, learner_status, is_nonmandatory_session, attendance_duration (seconds attended) and presence_intervals.

Notes: Fails with "Invalid Class ID" if you can't access the class. Contact number and email are blank if your institute restricts confidential fields for your role. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI