Get attendance scan output | SchoolSet

curl https://app.schoolset.io/app/api/v1/attendance/scan-sheet/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Attendance scan sheet retrieved successfully.",
  "data": {
    "scanId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "uploadedAt": "2024-06-10T09:15:00Z",
    "class": "Grade 10 - Section B",
    "sessionDate": "2024-06-09",
    "totalStudents": 30,
    "presentCount": 28,
    "absentCount": 2,
    "attendanceRecords": [
      {
        "studentId": "stu1001",
        "name": "Emma Johnson",
        "status": "present",
        "remarks": ""
      },
      {
        "studentId": "stu1002",
        "name": "Liam Smith",
        "status": "present",
        "remarks": ""
      },
      {
        "studentId": "stu1003",
        "name": "Olivia Brown",
        "status": "absent",
        "remarks": "Sick leave"
      },
      {
        "studentId": "stu1004",
        "name": "Noah Davis",
        "status": "present",
        "remarks": ""
      },
      {
        "studentId": "stu1005",
        "name": "Ava Wilson",
        "status": "absent",
        "remarks": "Family emergency"
      }
    ]
  }
}

Returns parsed output for a previously uploaded attendance scan by its scan ID.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/attendance/scan-sheet/{id}.

statusenum

Allowed values:

messagestring

datamap from strings to any