Docs home

Cancel Batch Class

Changes the status of a scheduled session: sign the tutor in (mark it as taken) or cancel it. Put the session's `attendance_id` (from "List of Batch Class") in the URL. To cancel, send `status` `3`.

POST/attendance/{attendance_id}/signin
Cancel Batch Class
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/attendance/{attendance_id}/signin' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"status":3,"send_sms":1}'
{
  "code": 200,
  "message": "Signed in"
}

Access: Institute admins, tutors, students and parents, plus custom roles that can sign in to sessions or manage mentoring sessions. The session must belong to a class in your organizations, or one you teach or created.

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

Path parameters
attendance_idintegerrequired
The session.
BodyJSONString
statusinteger
New session status. Default 1. 0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in, 6 Excused, 7 Absent.
send_smsinteger
0 skips the cancellation SMS. Default 1.
is_cancelinteger
0 skips all cancellation notifications. Default 1.
Send 0 when the session has no students, so it is shown as fully marked.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Signed in

Notes:

  • If someone other than the assigned tutor signs in with status 1, it is saved as 5 Missed sign-in, with a note naming who signed in and when.
  • A session that is already signed in can't be cancelled ("Cannot cancel signed in class !"). Fails with code 25001 "Invalid Attendance ID" if the session isn't found or isn't yours.
  • For batches with common (not per-subject) attendance, offline sessions of all the batch's subjects at that time are updated together.
  • Cancelling notifies students, parents, the tutor and admins by SMS and app notification, following your notification settings.
  • Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI