Query class attendance details record
<h5>Interface introduction</h5>
<p>Through this interface, you can query each member's in and out class record, actual class duration and other data in the reserved class section. SID, sign, timestamp and classroomid need to be provided. The query result information is returned after success, and the corresponding error description is returned after failure.</p>
<p>Note: attendance information can only be viewed after the end of the class section</p>
<h5>Request information</h5>
<table>
<thead>
<tr>
<th style="text-align: left;"></th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">URL</td>
<td style="text-align: left;"><a href="https://neukol.axzt.net/edu_openapi/supervise/queryAttendance">https://neukol.axzt.net/edu_openapi/supervise/queryAttendance</a></td>
</tr>
<tr>
<td style="text-align: left;">HTTP Request Methods</td>
<td style="text-align: left;">POST</td>
</tr>
<tr>
<td style="text-align: left;">Coding format</td>
<td style="text-align: left;">UTF-8</td>
</tr>
</tbody>
</table>
<h5>Request header</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Type</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td>no</td>
</tr>
</tbody>
</table>
<h5>Form parameter</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">True</td>
<td>Timestamp, the timestamp within 20 minutes of the sending request time</td>
<td>1605952111604</td>
</tr>
<tr>
<td style="text-align: left;">sid</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">True</td>
<td>The unique identifier of the institution is available on the first page of API description</td>
<td>5f4df4846acce059dc7cc8ba</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">True</td>
<td>Fixed 32-bit all lowercase characters, institution authentication security key，sign=MD5(params+SECRET)，Among them, params represents the concatenated string of all parameters in the request body except sign in lexicographic order（like: “key1=value1key2=value2”）</td>
</tr>
<tr>
<td style="text-align: left;">classroomId</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">True</td>
<td>Class section ID, which is returned when booking a class section</td>
<td>5fb8b266e5e9bea7dc64954d</td>
</tr>
</tbody>
</table>
<h5>Response parameter</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">responseHeader</td>
<td style="text-align: left;">Object</td>
<td style="text-align: left;"></td>
<td>Response header information</td>
</tr>
<tr>
<td style="text-align: left;"> └</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">True</td>
<td>HTTP response status code</td>
<td>200</td>
</tr>
<tr>
<td style="text-align: left;"> └</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td>Return information</td>
<td>OK</td>
</tr>
<tr>
<td style="text-align: left;">response</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td>Returns the query information. If there is an error, this field will not be returned</td>
</tr>
<tr>
<td style="text-align: left;"> └classroomId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td>Class section id</td>
<td>5fb8b266e5e9bea7dc64954d</td>
</tr>
<tr>
<td style="text-align: left;"> └userAttendanceInfos</td>
<td style="text-align: left;">List</td>
<td style="text-align: left;">True</td>
<td>User attendance record information in class section</td>
</tr>
<tr>
<td style="text-align: left;">  └userId</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td>User ID in the class section</td>
<td>studentThree</td>
</tr>
<tr>
<td style="text-align: left;">  └role</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td>The role corresponding to the user ID in the class section</td>
<td>STUDENT</td>
</tr>
<tr>
<td style="text-align: left;">  └actualDuration</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">True</td>
<td>Total duration of user ID in class section (timestamp, unit: ms)</td>
<td>4254001</td>
</tr>
<tr>
<td style="text-align: left;">  └attendanceTimes</td>
<td style="text-align: left;">List</td>
<td style="text-align: left;">True</td>
<td>Time list of user ID in and out of class section</td>
</tr>
<tr>
<td style="text-align: left;">   └joinTime</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">True</td>
<td>Time of entering the class section (timestamp, unit: ms)</td>
<td>1605943165810</td>
</tr>
<tr>
<td style="text-align: left;">   └leaveTime</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">True</td>
<td>Time to leave the class section (timestamp, unit: ms)</td>
<td>1605943476997</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/supervise/queryAttendance HTTP/1.1
Host: https://neukol.axzt.net/
Content-Type: application/x-www-form-urlencoded
timestamp=1605952111604&sid=5f4df4846acce059dc7cc8ba&sign=de70ef68bc3e1e0f1f4f4f17fecb7041&classRoomId=5fb8b266e5e9bea7dc64954d
</code></pre>
<h5>Response example</h5>
<pre><code>{
"responseHeader": {
"status": 200,
"msg": "OK"
},
"response": {
"classroomId": "5fb8b266e5e9bea7dc64954d",
"userAttendanceInfos": [
{
"userId": "studentThree",
"role": "STUDENT",
"attendanceTimes": [
{
"joinTime": 1605943165810,
"leaveTime": 1605943476997
}
],
"actualDuration": 4254001
},
{
"userId": "studentTwo",
"role": "STUDENT",
"attendanceTimes": [
{
"joinTime": 1605943168454,
"leaveTime": 1605943447553
}
],
"actualDuration": 4786337
},
{
"userId": "teacher2",
"role": "TEACHER",
"attendanceTimes": [
{
"joinTime": 1605943142442,
"leaveTime": 1605943512696
}
],
"actualDuration": 4711961
},
{
"userId": "studentSix",
"role": "STUDENT",
"attendanceTimes": [
{
"joinTime": 1605942124775,
"leaveTime": 1605944274477
}
],
"actualDuration": 3105226
}
]
}
}
</code></pre>
<h5>Error code</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Code value</th>
<th style="text-align: left;">Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">200</td>
<td style="text-align: left;">Folder created successfully</td>
</tr>
<tr>
<td style="text-align: left;">9994</td>
<td style="text-align: left;">Parameter format error</td>
</tr>
<tr>
<td style="text-align: left;">2000</td>
<td style="text-align: left;">sign certification failed</td>
</tr>
<tr>
<td style="text-align: left;">2001</td>
<td style="text-align: left;">Request timeout</td>
</tr>
<tr>
<td style="text-align: left;">2002</td>
<td style="text-align: left;">Institution does not open an open interface</td>
</tr>
<tr>
<td style="text-align: left;">2010</td>
<td style="text-align: left;">Institution is inexistent</td>
</tr>
<tr>
<td style="text-align: left;">500</td>
<td style="text-align: left;">unknown exception on the server</td>
</tr>
</tbody>
</table>