Docs home

Session Attendance

Returns one session with every applicable student's attendance status. Put the session's `attendance_id` in the URL. Use it to read attendance after a session or before updating it with "Update Session Attendance".

GET/class/attendance/{attendance_id}
Session Attendance
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/class/attendance/{attendance_id}?previous_attendance=5&response_type=1' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "payload": {
    "attendance": {
      "id": 8914546,
      "taken_by": 71595927,
      "taken_by_name": "Atul",
      "class_date": 1733941800,
      "start_time": 1200,
      "end_time": 1260,
      "status": 1,
      "taken_at": 1733986628,
      "signin_by": 71595927,
      "signin_by_name": "Atul",
      "class_name": "Introduction to Management",
      "class_id": 96909,
      "total_students": 31,
      "present": 8,
      "admin_data": {
        "canChangeTime": null,
        "canChangeDate": null,
        "pay": 0
      },
      "student_data": [
        {
          "studentId": 90158032,
          "name": "Arnab Chaudhuri",
          "status": 1,
          "remarks": "",
          "user_status": 1,
          "user_status_time": 0,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "8870686746",
          "reg_id": "67",
          "p_img_url": "",
          "org_status": 2,
          "email": "arnab@edmingle.com"
        },
        {
          "studentId": 88903883,
          "name": "Ashok",
          "status": 1,
          "remarks": "",
          "user_status": 1,
          "user_status_time": 0,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "9980160026",
          "reg_id": "13",
          "p_img_url": "",
          "org_status": 2,
          "email": "ashokmohanty81@gmail.com"
        },
        {
          "studentId": 67608842,
          "name": "ATUL TIWARI",
          "status": 1,
          "remarks": "",
          "user_status": 1,
          "user_status_time": 0,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "8209627747",
          "reg_id": "6",
          "p_img_url": "",
          "org_status": 2,
          "email": "tiwariatul66@gmail.com"
        },
        {
          "studentId": 90605374,
          "name": "BR",
          "status": 0,
          "remarks": "",
          "user_status": 0,
          "user_status_time": 1733986290,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "9999988888",
          "reg_id": "1239",
          "p_img_url": "",
          "org_status": 2,
          "email": "branch@gmail.com"
        },
        {
          "studentId": 62038738,
          "name": "Demo Student",
          "status": 0,
          "remarks": "",
          "user_status": 0,
          "user_status_time": 1733986290,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "https://dme2wmiz2suov.cloudfront.net/User(62038738)/1552316-IICE.png",
          "user_state": 3,
          "contact_number": "9999999999",
          "reg_id": "3",
          "p_img_url": "",
          "org_status": 2,
          "email": "demo1@edmingle.com"
        },
        {
          "studentId": 62038844,
          "name": "Demo Student 2",
          "status": 0,
          "remarks": "",
          "user_status": 0,
          "user_status_time": 1733986290,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "9999999998",
          "reg_id": "4",
          "p_img_url": "",
          "org_status": 2,
          "email": "demo2@edmingle.com"
        },
        {
          "studentId": 89279006,
          "name": "Harshit S",
          "status": 0,
          "remarks": "",
          "user_status": 0,
          "user_status_time": 1733986290,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "8870686747",
          "reg_id": "0092",
          "p_img_url": "",
          "org_status": 2,
          "email": "harshit@edmingle.com"
        },
        {
          "studentId": 91016623,
          "name": "Rishabh",
          "status": 0,
          "remarks": "",
          "user_status": 0,
          "user_status_time": 1733986290,
          "user_rating": 0,
          "user_comments": "",
          "parent_id": 0,
          "parent_name": "",
          "parent_status": 0,
          "parent_status_time": 0,
          "parent_rating": 0,
          "parent_comments": "",
          "img_url": "",
          "user_state": 1,
          "contact_number": "7355031540",
          "reg_id": "1250",
          "p_img_url": "",
          "org_status": 2,
          "email": "rishabh@edmingle.com"
        }
      ],
      "not_marked": 6,
      "class_type": 3,
      "topics_taught": "Marketing-101",
      "pages_taught": "",
      "homework": "",
      "topics_taught_ids": "",
      "signout_at": 1733986290,
      "signout_by": 71595927,
      "signout_by_name": "Atul",
      "teacher_class_date": 1733941800,
      "teacher_start_time": 1200,
      "teacher_end_time": 1260,
      "signout_status": 0,
      "is_live": 3,
      "zoom_room_waiting": 0,
      "master_batch_id": 41414,
      "master_batch_name": "Introduction to Computer Vision",
      "individual_batch_attendance": 0,
      "external_class_link": "",
      "virtual_class_type": 1,
      "is_free_enrolment": 0,
      "master_batches": [
        {
          "master_batch_id": "41414",
          "master_batch_name": "Introduction to Computer Vision"
        },
        {
          "master_batch_id": "41415",
          "master_batch_name": "First Principles of Computer Vision Specialization"
        },
        {
          "master_batch_id": "41416",
          "master_batch_name": "Basics in computer vision Specialization"
        },
        {
          "master_batch_id": "41417",
          "master_batch_name": "Computer Vision with Embedded Machine Learning"
        },
        {
          "master_batch_id": "41418",
          "master_batch_name": null
        }
      ],
      "is_sharable_link_enabled": false,
      "can_join_without_login": false,
      "joining_link": null,
      "feedback_form_id": "66b34352c372a3971803e896"
    }
  }
}

Access: Any logged-in user who can see the session: admins and tutors of the class's organization, the class tutor or creator, and enrolled students. Students only see their own row.

Path parameters
attendance_idintegerrequired
The session.
Query parameters
1 returns named fields. Leave it out to get arrays without keys, in the field order of "List of Batch Class".
Up to 10. Adds each student's status in this many most recent sessions of the class (up to and including this one), as [attendance_id, status] pairs. Works only without response_type, and replaces the last field of each student row.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
payloadobject
Show child attributesHide child attributes
Show child attributesHide child attributes
Example: 8914546
Example: 71595927
Example: 1733941800
Example: 1200
Example: 1260
Example: 1
Example: 1733986628
Example: 71595927
Example: Introduction to Management
Example: 96909
Example: Marketing-101
Example: 1733986290
Example: 71595927
Example: 1733941800
Example: Introduction to Computer Vision
Show child attributesHide child attributes
Example: Introduction to Computer Vision
Example: 66b34352c372a3971803e896

Notes: Contact number and email are blank if your institute restricts confidential fields for your role. Fails with code 25001 "Invalid Attendance ID" if the session isn't found or isn't yours. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI