Get class section info by conditional pagin
<h5>Interface introduction</h5>
<p>-The conditional paging query class list interface is used to query the class section, and the conditional paging query class list information. The default paging start page is 1, and the paging size is 10. According to agency ID, class name, class type, class start time, class start time cut-off, teacher ID, and student ID information query list, sid, timestamp, sign are required. Details are shown in the form parameters.</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/query">https://neukol.axzt.net/edu_openapi/booking/class/query</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 parameters</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;">False</td>
<td style="text-align: left;">Class ID</td>
<td style="text-align: left;">5f195b1b2302bdedee4809c0</td>
</tr>
<tr>
<td style="text-align: left;">className</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Class name, maximum 20 characters</td>
<td style="text-align: left;">First Lesson of Mr. Ma's Lecture</td>
</tr>
<tr>
<td style="text-align: left;">startTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Course start time start time stamp, unit : milliseconds</td>
<td style="text-align: left;">1605672882910</td>
</tr>
<tr>
<td style="text-align: left;">endTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Class start time cut-off timestamp, unit : milliseconds.</td>
<td style="text-align: left;">1605672883910</td>
</tr>
<tr>
<td style="text-align: left;">teacher</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Teacher ID User ID Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account(like: tea00001)Format 2 : country code + character’ # ‘ + mobile phone number, indicating mobile phone account number(like: 86#15751860597)</td>
<td style="text-align: left;">teacher0010</td>
</tr>
<tr>
<td style="text-align: left;">student</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Student ID User ID Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account(like: tea00001)Format 2 : country code + character’ # ‘ + mobile phone number, indicating mobile phone account number(like: 86#15751860597)</td>
<td style="text-align: left;">stu0011</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Customize lesson types, up to 20 characters</td>
<td style="text-align: left;">Mathematics / Physics / Chinese language and literature</td>
</tr>
<tr>
<td style="text-align: left;">classType</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Class type : 1 - Open interface class scheduling, 2 - Teachers start class at Neukol ( including fast class and booking class )</td>
<td style="text-align: left;">1</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;">Paging 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, defaults to 10</td>
<td style="text-align: left;">10</td>
</tr>
</tbody>
</table>
<h5>Response parameter description</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>List of query results</td>
<td>Query result content</td>
</tr>
<tr>
<td style="text-align: left;">  └classroomId</td>
<td style="text-align: left;">String</td>
<td>Class sectionID</td>
<td>5fb62727e5e9be63846a306a</td>
</tr>
<tr>
<td style="text-align: left;">  └ctime</td>
<td style="text-align: left;">Long</td>
<td>creation time, unit : millisecond</td>
<td>1605773095505</td>
</tr>
<tr>
<td style="text-align: left;">  └schoolId</td>
<td style="text-align: left;">String</td>
<td>Institution ID</td>
<td>5f1140092302bd0ac2dbc7c4</td>
</tr>
<tr>
<td style="text-align: left;">  └startTime</td>
<td style="text-align: left;">Long</td>
<td>Class start time, unit: milliseconds</td>
<td>1605618057000</td>
</tr>
<tr>
<td style="text-align: left;">  └resolutionType</td>
<td style="text-align: left;">Enum</td>
<td>resolution</td>
<td>RESOLUTION_480P</td>
</tr>
<tr>
<td style="text-align: left;">  └picMonitor</td>
<td style="text-align: left;">boolena</td>
<td>Whether to open the picture monitoring class</td>
<td>false</td>
</tr>
<tr>
<td style="text-align: left;">  └readyTime</td>
<td style="text-align: left;">Long</td>
<td>Lesson preparation time, unit : milliseconds</td>
<td>1200000</td>
</tr>
<tr>
<td style="text-align: left;">  └extraTime</td>
<td style="text-align: left;">Long</td>
<td>Lesson drag time, unit: milliseconds</td>
<td>1200000</td>
</tr>
<tr>
<td style="text-align: left;">  └music</td>
<td style="text-align: left;">String</td>
<td>Music lesson mode ( 1-open ; 0 − Close)</td>
<td>0</td>
</tr>
<tr>
<td style="text-align: left;">  └layout</td>
<td style="text-align: left;">String</td>
<td>Classroom layout mode ( 0-vertical screen ; 2 - Left-right layout )</td>
<td>2</td>
</tr>
<tr>
<td style="text-align: left;">  └platformCount</td>
<td style="text-align: left;">Integer</td>
<td>Number of people who can be on stage</td>
<td>7</td>
</tr>
<tr>
<td style="text-align: left;">  └checkMember</td>
<td style="text-align: left;">boolean</td>
<td>Whether to check members</td>
<td>false</td>
</tr>
<tr>
<td style="text-align: left;">  └className</td>
<td style="text-align: left;">String</td>
<td>Class name, 20 characters below, fuzzy search</td>
<td>Teacher Zhao's second lecture every day</td>
</tr>
<tr>
<td style="text-align: left;">  └endTime</td>
<td style="text-align: left;">Long</td>
<td>End time of class, unit : milliseconds</td>
<td>1605704457000</td>
</tr>
<tr>
<td style="text-align: left;">  └teacher</td>
<td style="text-align: left;">String</td>
<td>Class Teacher ID, 3-20 characters</td>
<td>teacher0011</td>
</tr>
<tr>
<td style="text-align: left;">  └student</td>
<td style="text-align: left;">List</td>
<td>Class Student ID, 3-20 characters</td>
<td>studet0011</td>
</tr>
<tr>
<td style="text-align: left;">  └assistant</td>
<td style="text-align: left;">String</td>
<td>Assistant id</td>
<td>assistant_id</td>
</tr>
<tr>
<td style="text-align: left;">  └cloudRecord</td>
<td style="text-align: left;">String</td>
<td>RESOLUTION 720P ( forced to 720p cloud recording ), ALLOW RESOLUTION 720P ( allow teachers to 720p cloud recording, requires the teacher manually click start recording ), NO RECORD ( do not allow cloud recording ), currently open cloud recording is recorded in 720p)</td>
<td>NO_RECORD</td>
</tr>
<tr>
<td style="text-align: left;">  └localRecord</td>
<td style="text-align: left;">String</td>
<td>ALLOW RECORD ( allow teachers to local recording ), NO RECORD ( do not allow local recording )</td>
<td>NO_RECORD</td>
</tr>
<tr>
<td style="text-align: left;">  └recordVideos</td>
<td style="text-align: left;">String[]</td>
<td>Cloud recording video list usually has only one. At present, the effective time for playing links is 30 minutes.</td>
<td><a href="https://media.live.axzt.net/sv/413430fe-176f9bce5e4/413430fe-176f9bce5e4.mp4?auth_key=11">https://media.live.axzt.net/sv/413430fe-176f9bce5e4/413430fe-176f9bce5e4.mp4?auth_key=11</a></td>
</tr>
<tr>
<td style="text-align: left;">  └teacherPlayback</td>
<td style="text-align: left;">Boolean</td>
<td>Whether to enable teachers and teaching assistants to view playback permissions on the client</td>
<td>false</td>
</tr>
<tr>
<td style="text-align: left;">  └studentPlayback</td>
<td style="text-align: left;">Boolean</td>
<td>Whether to enable the student's permission to view playback on the client</td>
<td>false</td>
</tr>
<tr>
<td style="text-align: left;">  └picMonitorStatus</td>
<td style="text-align: left;">Enum</td>
<td>Supervising picture status, OPEN is open, CLOSE is closed, DELETED has been deleted</td>
<td>false</td>
</tr>
<tr>
<td style="text-align: left;">  └recordStatus</td>
<td style="text-align: left;">Enum</td>
<td>Cloud recording status, SUCCESS success, FAIL failure, IN <em> RECORD recording, NO </em> RECORD not recording, DELETED recording deleted, NOT _ START user not recording operation, UNAUTHORIZED user device not authorized, ERROR program error</td>
<td>false</td>
</tr>
<tr>
<td style="text-align: left;">  └classType</td>
<td style="text-align: left;">Integer</td>
<td>Class type : 1 - Open interface class scheduling, 2 - Teachers start class at Neukol ( including fast class and booking class )</td>
<td>1</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/booking/class/query HTTP/1.1
Host: https://neukol.axzt.net
Content-Type: application/x-www-form-urlencoded
timestamp=1598880734439&sid=5f195b1b2302bdedee4809c0&sign=bf972bbd42ef1746b3ccf24c396b4762&teacher=teacher0011</code></pre>
<h5>Response example</h5>
<pre><code>{
"responseHeader": {
"status": 200,
"msg": "OK"
},
"response": {
"total": 1,
"content": [
{
"classroomId": "5fb62727e5e9be63846a306a",
"ctime": 1605773095505,
"schoolId": "5f1140092302bd0ac2dbc7c4",
"startTime": 1605618057000,
"resolutionType": "RESOLUTION_480P",
"picMonitor": false,
"readyTime": 1200000,
"extraTime": 1200000,
"music": "0",
"layout": "2",
"platformCount": 7,
"checkMember": false,
"className": "Teacher Zhao's second lecture every day",
"endTime": 1605704457000,
"teacher": "teacher0011",
"students": [
"student0011",
"student0012"
],
"cloudRecord": "NO_RECORD",
"localRecord": "NO_RECORD",
"recordVideos": ["https://media.live.axzt.net/sv/413430fe-176f9bce5e4/413430fe-176f9bce5e4.mp4?auth_key=11"],
"teacherPlayback": false,
"studentPlayback": false,
"picMonitorStatus": "OPEN",
"recordStatus": "SUCCESS"
}
]
}
}</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>