¶ SYNC API
¶ Getting started
To access the SYNC API, you must first obtain a valid "Access Key". For now, please contact our support team to obtain an access key.
For all SYNC API calls, please include the following headers to your request for authentication:
X-App-Id: The unique identifier of your school.
X-Access-Key: The access key.
content-type: "application/json" unless specified otherwise.
Example:
GET https://liveapi.edu.ink/units/100/years/105/groups/Class 2-B/attendance-lists/2020-10-27
content-type: application/json
X-App-Id: {{appId}}
X-Access-Key: {{accessKey}}
¶ Attendance List
This API can get the attendance list of a specific combination of unit + year + group + date. You can find the corresponding ID from Console > Settings > School Structures:
¶ GET https://liveapi.edu.ink/units/(unitId)/years/(yearId)/groups/(groupName)/attendance-lists/(YYYY-MM-DD)
URL Params:
- unitId: unit integer Id
- yearId: year integer Id
- groupName: the group name
- date: in the format of YYYY-MM-DD
¶ Response:
An array of all students in the group. The property attendanceEntry contains the attendance record of the day. attendanceEntry.status has the following possible values:
"Present""Unexcused"(a.k.a. absent without notice)"Excused"(a.k.a. took a day of with proper notice)"Late""EarlyLeave"
[
{
"_id": 120,
"refNo": "E18070514",
"firstName": "Harley",
"lastName": "Hu",
"imageUrl": "https://ui-avatars.com/api/?background=FFB900&color=59524F&name=Harley+Hu",
"attendanceEntry": {
"_id": 262,
"status": "Present",
"user": 120,
"entryDate": "2020-10-27T01:00:00.000Z",
"note": "",
"approvedBy": {
"_id": 129,
"firstName": "Calvin",
"lastName": "Chan"
},
"approvedAt": "2020-10-27T07:00:37.284Z"
}
}
]