Docs home

Setup Extra Class

Adds a one-off extra session to a class (subject batch), outside its regular schedule. Put the class ID (from "Get Batch Details") in the URL. You can target all enrolled students or only some of them.

POST/class/{class_id}/extra
Setup Extra Class
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/class/{class_id}/extra' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"tutor_id":"15","class_date":"21 Jul 2022","s_hour":13,"s_minute":0,"e_hour":14,"e_minute":0,"topics":"THis Is Extra Class","virtual_class_type":0,"all_selected":true}'
{
  "code": 5010,
  "message": "The tutor assigned to this class is not available in the given time slot(s)."
}

Access: Institute admins, tutors, students and parents, plus custom roles with scheduling write permission. The class must belong to your current organization.

Request body: form-data with one field, JSONString, containing this JSON:

Path parameters
class_idintegerrequired
The class to add the session to.
BodyJSONString
tutor_idintegerrequired
Tutor who will take the session. Must be a member of your organization.
class_datestringrequired
Session date, as D Mon YYYY (for example 1 Jul 2022).
s_hourinteger
Start hour, 0-23, in your timezone. Default 0.
s_minuteinteger
Start minute. Default 0.
e_hourinteger
End hour, 0-23. Default 0.
e_minuteinteger
End minute. Default 0.
1 if the session ends after midnight. Without it, an end time earlier than the start time fails with code 5021.
student_idsarray of integers
Students who should attend. Each must be enrolled in this class. Other enrolled students are marked "Not applicable" for the session.
true to notify every enrolled student; student_ids is then ignored.
topicsstring
Topics to be taught.
is_liveinteger
1 for a live (online) session, 0 for offline. Default 0.
Only when is_live is 1: 1 Zoom Meeting (default), 5 Zoom Webinar, 6 Custom Link.
1 to turn on the Zoom waiting room.
class_typeinteger
Session type: 2 Extra (default), 1 Exam, 0 Normal.
Linked content, for example the test for an exam session. Default 0.
1 marks the session as optional.
send_smsinteger
0 to skip notifications. Default 1.
1 skips the tutor, student and duplicate-session clash checks.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Class Created

Notes: Unless force_schedule is 1, the request fails with code 5010 "The tutor assigned to this class is not available in the given time slot(s).", 5011 if students have another session then (the message lists the clashes), or 5012 "Class already scheduled for given date and time." Notifications (SMS and app) go to the selected students, their parents, the tutor and admins, following your notification settings. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI