Docs home

Student Calendar

Lists the logged-in learner's sessions in a day, week or month (class sessions, merged batch sessions and mentoring sessions), with their own attendance for each. Use it for a learner's "today" view or calendar.

GET/student/classes/period
Student Calendar
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/student/classes/period?period=2&date=12-2023' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "payload": {
        "classes": [
            [
                5962117,
                53044146,
                "Edmingle Academy",
                1701388800,
                780,
                810,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test course",
                136916,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701388800,
                780,
                810,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5951209,
                53044146,
                "Edmingle Academy",
                1701388800,
                900,
                960,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "Zoom",
                136915,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701388800,
                900,
                960,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5959752,
                53044146,
                "Edmingle Academy",
                1701388800,
                1080,
                1140,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test demo",
                136917,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701388800,
                1080,
                1140,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5951210,
                53044146,
                "Edmingle Academy",
                1701475200,
                600,
                600,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "Zoom",
                136915,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701475200,
                600,
                600,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5962118,
                53044146,
                "Edmingle Academy",
                1701475200,
                660,
                660,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test course",
                136916,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701475200,
                660,
                660,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5959753,
                53044146,
                "Edmingle Academy",
                1701475200,
                720,
                720,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test demo",
                136917,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701475200,
                720,
                720,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5951211,
                53044146,
                "Edmingle Academy",
                1701561600,
                600,
                600,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "Zoom",
                136915,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701561600,
                600,
                600,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5962119,
                53044146,
                "Edmingle Academy",
                1701561600,
                660,
                660,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test course",
                136916,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701561600,
                660,
                660,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5959754,
                53044146,
                "Edmingle Academy",
                1701561600,
                720,
                720,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test demo",
                136917,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701561600,
                720,
                720,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5951212,
                53044146,
                "Edmingle Academy",
                1701648000,
                600,
                600,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "Zoom",
                136915,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701648000,
                600,
                600,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5962120,
                53044146,
                "Edmingle Academy",
                1701648000,
                660,
                660,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test course",
                136916,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701648000,
                660,
                660,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
                null,
                5,
                0,
                []
            ],
            [
                5959755,
                53044146,
                "Edmingle Academy",
                1701648000,
                720,
                720,
                0,
                -1,
                53044146,
                "Edmingle Academy",
                "test demo",
                136917,
                1,
                0,
                [
                    0,
                    0,
                    0
                ],
                [
                    [
                        90038690,
                        "DemojhJGjh",
                        -1,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        0,
                        "",
                        0,
                        -1,
                        0,
                        "",
                        "",
                        1,
                        "9879878987",
                        "402",
                        "",
                        2,
                        "hemal+demo@edmingle.com"
                    ]
                ],
                1,
                0,
                "",
                "",
                "",
                "",
                0,
                53044146,
                "Edmingle Academy",
                1701648000,
                720,
                720,
                0,
                1,
                0,
                59406,
                "Zoom",
                0,
               

Access: Learners (their own sessions).

Query parameters
periodinteger
0 one day (default), 1 the week, 2 the month containing date.
datestring
A day in the period, e.g. 25-12-2024. Default: today in your time zone.
Only this organization. Default: all the learner's organizations.
1 returns each session as a JSON object. Default: positional arrays.

Response: payload.classes is a list of sessions, earliest first, with times converted to the learner's time zone. Each session has, in this order (as array positions by default, or as keys with response_type=1): id (session ID), taken_by, taken_by_name, class_date (midnight of the day, Unix timestamp), start_time and end_time (minutes from midnight, in your time zone), status, 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, 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, zoom_room_waiting, master_batch_id, master_batch_name, individual_batch_attendance, external_class_link, virtual_class_type, 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. student_data holds the learner's own record: studentId, name, status, remarks, 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) and presence_intervals.

Notes: Session status: 0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in. class_type: 0 Normal, 1 Exam, 2 Extra, 3 Merged (one session for several classes), 4 Event, 5 Mentoring. virtual_class_type: 0 offline, 1 Zoom Meeting, 2 BotSite, 3 GoTo, 4 GoTo Meeting, 5 Zoom Webinar, 6 Custom link, 7 Super Live, 8 MS Teams. Learner attendance status: -1 Not marked yet, 0 Absent, 1 Present, 2 Late, 3 Excused, 4 Leave, 5 Not applicable. Sessions of archived classes and extra sessions that don't apply to the learner are left out. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI