Pagination query class section events
<h5>Interface introduction</h5>
<p>-To query the events in a class section by page, you need the class section ID, page number and the number of records per page to query the event information list of the current class section</p>
<h5>Interface 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/booking/class/queryClassroomEvent">https://neukol.axzt.net/edu_openapi/booking/class/queryClassroomEvent</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;">Field name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
<th style="text-align: left;">Example</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 style="text-align: left;">no</td>
<td style="text-align: left;">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 style="text-align: left;">Description</th>
<th style="text-align: left;">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">sid</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Institution ID</td>
<td style="text-align: left;">5f1140092302bd0ac2dbc7c4</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 style="text-align: left;">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>
<td style="text-align: left;">c09636a3a529a386fdaa389228e36fac</td>
</tr>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">True</td>
<td style="text-align: left;">Unix Epoch timestamp within 20 minutes of current calling interface, unit: milliseconds</td>
<td style="text-align: left;">1600140360000</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 style="text-align: left;">Class section ID</td>
<td style="text-align: left;">5f195b1b2302bdedee4809c0</td>
</tr>
<tr>
<td style="text-align: left;">eventName</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Event type, fuzzy search</td>
<td style="text-align: left;">open</td>
</tr>
<tr>
<td style="text-align: left;">pageNumber</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Pagination start page, default = 1</td>
<td style="text-align: left;">1</td>
</tr>
<tr>
<td style="text-align: left;">pageSize</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Page size, default = 10</td>
<td style="text-align: left;">10</td>
</tr>
</tbody>
</table>
<h5>Response parameter explanation</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Type</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>Response header information</td>
</tr>
<tr>
<td style="text-align: left;"> └status</td>
<td style="text-align: left;">int</td>
<td>HTTP corresponding status code</td>
<td>200</td>
</tr>
<tr>
<td style="text-align: left;"> └msg</td>
<td style="text-align: left;">String</td>
<td>Error message</td>
<td>OK</td>
</tr>
<tr>
<td style="text-align: left;">response</td>
<td style="text-align: left;">Object</td>
<td>Response body content</td>
</tr>
<tr>
<td style="text-align: left;"> └total</td>
<td style="text-align: left;">int</td>
<td>Total record of query results</td>
<td>2</td>
</tr>
<tr>
<td style="text-align: left;"> └content</td>
<td style="text-align: left;">List</td>
<td>Query result list</td>
<td>Query result content</td>
</tr>
<tr>
<td style="text-align: left;"> └id</td>
<td style="text-align: left;">Long</td>
<td>Event ID</td>
<td>123</td>
</tr>
<tr>
<td style="text-align: left;"> └classroomId</td>
<td style="text-align: left;">String</td>
<td>Class section ID</td>
<td>5fb62727e5e9be63846a306a</td>
</tr>
<tr>
<td style="text-align: left;"> └sessionId</td>
<td style="text-align: left;">String</td>
<td>Call ID</td>
<td>5fb62727e5e9be63846a306a</td>
</tr>
<tr>
<td style="text-align: left;"> └event</td>
<td style="text-align: left;">String</td>
<td>Event type</td>
<td>JOIN</td>
</tr>
<tr>
<td style="text-align: left;"> └eventName</td>
<td style="text-align: left;">String</td>
<td>Event name</td>
<td>Join the class</td>
</tr>
<tr>
<td style="text-align: left;"> └operationTime</td>
<td style="text-align: left;">Long</td>
<td>Event operation time, unit: milliseconds</td>
<td>1605618057000</td>
</tr>
<tr>
<td style="text-align: left;"> └operatorUserId</td>
<td style="text-align: left;">String</td>
<td>Operator third party organization ID</td>
<td>teacherWang</td>
</tr>
<tr>
<td style="text-align: left;"> └operatorName</td>
<td style="text-align: left;">String</td>
<td>Operator name</td>
<td>Teacher Wang</td>
</tr>
<tr>
<td style="text-align: left;"> └operatorRole</td>
<td style="text-align: left;">String</td>
<td>Operator role</td>
<td>TEACHER</td>
</tr>
<tr>
<td style="text-align: left;"> └targetUserIds</td>
<td style="text-align: left;">String</td>
<td>The ID array of the third-party organization of the operator, separated by commas</td>
<td>studentGuo1,studentGuo2</td>
</tr>
<tr>
<td style="text-align: left;"> └targetNames</td>
<td style="text-align: left;">String</td>
<td>Operator name array</td>
<td>Dada, Xiaoxiao</td>
</tr>
<tr>
<td style="text-align: left;"> └eventDesc</td>
<td style="text-align: left;">String</td>
<td>Event description</td>
<td>Mr. Wang turns off Dada and Xiaoxiao's microphone</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/booking/class/queryClassroomEvent HTTP/1.1
Host: https://neukol.axzt.net
Content-Type: application/x-www-form-urlencoded
sign=45104ea711963e1b595d974a376ec738&classroomId=5fc5dde9e5e9be63d9f8c86e&sid=5f1140092302bd0ac2dbc7c4×tamp=1606815300357</code></pre>
<h5>Response example</h5>
<pre><code> {
"responseHeader": {
"status": 200,
"msg": "OK"
},
"response": {
"total": 2,
"content": [
{
"id": 123,
"classroomId": "5fc5dde9e5e9be63d9f8c86e",
"sessionId": "1234567",
"event": "JOIN",
"operationTime": 1606815346280,
"operatorUserId": "teacherWang",
"operatorRole": "TEACHER",
"targetUserIds": "teacherWang",
"eventName": "Enter the classroom",
"operatorName": "Teacher Wang",
"targetNames": "Teacher Wang",
"eventDesc": "Teacher Wang entered the classroom"
},
{
"id": 123,
"classroomId": "5fc5dde9e5e9be63d9f8c86e",
"sessionId": "1234567",
"event": "LEAVE",
"operationTime": 1606815346280,
"operatorUserId": "teacherWang",
"operatorRole": "TEACHER",
"targetUserIds": "teacherWang",
"eventName": "Leave class",
"operatorName": "Teacher Wang",
"targetNames": "Teacher Wang",
"eventDesc": "Teacher Wang left the classroom"
}
]
}
}
</code></pre>
<h5>Error code</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Error code</th>
<th>Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">9994</td>
<td>Parameter format error</td>
</tr>
<tr>
<td style="text-align: left;">2000</td>
<td>sign certification failed</td>
</tr>
<tr>
<td style="text-align: left;">2001</td>
<td>Request timeout</td>
</tr>
<tr>
<td style="text-align: left;">2002</td>
<td>Institution does not open an open interface</td>
</tr>
<tr>
<td style="text-align: left;">2010</td>
<td>Institution is inexistent</td>
</tr>
<tr>
<td style="text-align: left;">500</td>
<td>unknown exception on the server</td>
</tr>
</tbody>
</table>
<h5>Event type</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Event type</th>
<th>Event name</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">JOIN</td>
<td>Enter the classroom</td>
</tr>
<tr>
<td style="text-align: left;">LEAVE</td>
<td>Leave the classroom</td>
</tr>
<tr>
<td style="text-align: left;">END</td>
<td>End of call</td>
</tr>
<tr>
<td style="text-align: left;">MIC_OPEN</td>
<td>Turn on the microphone</td>
</tr>
<tr>
<td style="text-align: left;">MIC_CLOSE</td>
<td>Turn off the microphone</td>
</tr>
<tr>
<td style="text-align: left;">CAMERA_OPEN</td>
<td>Turn on the camera</td>
</tr>
<tr>
<td style="text-align: left;">CAMERA_CLOSE</td>
<td>Turn off the camera</td>
</tr>
<tr>
<td style="text-align: left;">SILENCE_OPEN</td>
<td>Turn on global mute</td>
</tr>
<tr>
<td style="text-align: left;">SILENCE_CLOSE</td>
<td>Turn off global mute</td>
</tr>
<tr>
<td style="text-align: left;">CUP_CHANGE</td>
<td>Award trophies</td>
</tr>
<tr>
<td style="text-align: left;">PLATFORM_UP</td>
<td>Go up onto the platform</td>
</tr>
<tr>
<td style="text-align: left;">PLATFORM_DOWN</td>
<td>Step down from the platform</td>
</tr>
<tr>
<td style="text-align: left;">BRUSH_OPEN</td>
<td>Authorized brush</td>
</tr>
<tr>
<td style="text-align: left;">BRUSH_CLOSE</td>
<td>Unlicense brush</td>
</tr>
<tr>
<td style="text-align: left;">RAISE_HAND</td>
<td>Raise hands</td>
</tr>
<tr>
<td style="text-align: left;">BLACKBOARD_UP</td>
<td>On the blackboard</td>
</tr>
<tr>
<td style="text-align: left;">BLACKBOARD_DOWN</td>
<td>Off the blackboard</td>
</tr>
<tr>
<td style="text-align: left;">COURSEWARE_OPEN</td>
<td>Open courseware</td>
</tr>
<tr>
<td style="text-align: left;">COURSEWARE_CLOSE</td>
<td>Close courseware</td>
</tr>
<tr>
<td style="text-align: left;">SCREEN_SHARE_OPEN</td>
<td>Open sharing screen</td>
</tr>
<tr>
<td style="text-align: left;">SCREEN_SHARE_CLOSE</td>
<td>Close sharing screen</td>
</tr>
</tbody>
</table>