Today Classes
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.
/student/classes/periodcurl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/student/classes/period?date=08%20Nov%202023' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"payload": {
"classes": [
[
5951186,
53044146,
"Edmingle Academy",
1699401600,
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",
1699401600,
600,
600,
0,
1,
0,
59406,
"Zoom",
0,
null,
5,
0,
[]
],
[
5962094,
53044146,
"Edmingle Academy",
1699401600,
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",
1699401600,
660,
660,
0,
1,
0,
59406,
"Zoom",
0,
null,
5,
0,
[]
],
[
5959729,
53044146,
"Edmingle Academy",
1699401600,
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",
1699401600,
720,
720,
0,
1,
0,
59406,
"Zoom",
0,
null,
5,
0,
[]
]
]
}
}Access: Learners (their own sessions).
0 one day (default), 1 the week, 2 the month containing date.25-12-2024. Default: today in your time zone.1 returns each session as a JSON object. Default: positional arrays.200SuccessShow child attributesHide child attributes
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.