Edit institution configuration
<h5>interface introduction</h5>
<p>-The editing institution configuration information interface is used to edit the institution configuration information, including definition configuration, lesson preparation preparation time, delay time, whether to start picture class supervision, whether to check members, music class Festival mode, classroom layout mode, number of people on stage, Sid, timestamp and sign required. See the form parameter list for details</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/school/update">https://neukol.axzt.net/edu_openapi/school/update</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;">Filed 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;">Filed 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;">Third party 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;">resolutionType</td>
<td style="text-align: left;">Enum</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Video definition configuration (resolution_480p SD, resolution_720p HD, resolution_1080p Full HD)</td>
<td style="text-align: left;">RESOLUTION_480P</td>
</tr>
<tr>
<td style="text-align: left;">readyTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Lesson preparation time, UNIX epoch timestamp, unit: ms</td>
<td style="text-align: left;">1605672882910</td>
</tr>
<tr>
<td style="text-align: left;">extraTime</td>
<td style="text-align: left;">Long</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Drap time, UNIX epoch timestamp, unit: ms</td>
<td style="text-align: left;">1605672883910</td>
</tr>
<tr>
<td style="text-align: left;">picMonitor</td>
<td style="text-align: left;">Boolean</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Whether to supervise class with pictures</td>
<td style="text-align: left;">false</td>
</tr>
<tr>
<td style="text-align: left;">checkMember</td>
<td style="text-align: left;">Boolean</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Whether to check members</td>
<td style="text-align: left;">false</td>
</tr>
<tr>
<td style="text-align: left;">music</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Music class mode (1-on; 0-off）</td>
<td style="text-align: left;">0</td>
</tr>
<tr>
<td style="text-align: left;">layout</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Classroom layout mode (0 - vertical screen; 2 - horizontal screen - left and right layout）</td>
<td style="text-align: left;">2</td>
</tr>
<tr>
<td style="text-align: left;">platformCount</td>
<td style="text-align: left;">Integer</td>
<td style="text-align: left;">False</td>
<td style="text-align: left;">Number of people on stage (2-1v1; 7-1v6）</td>
<td style="text-align: left;">7</td>
</tr>
</tbody>
</table>
<h5>Response parameter explanation</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Filed 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;"> └sid</td>
<td style="text-align: left;">String</td>
<td>Third party institution ID</td>
<td>5f1140092302bd0ac2dbc7c4</td>
</tr>
<tr>
<td style="text-align: left;"> └resolutionType</td>
<td style="text-align: left;">Enum</td>
<td>Video definition configuration (resolution_480p SD, resolution_720p HD, resolution_1080p Full HD)</td>
<td>RESOLUTION_480P</td>
</tr>
<tr>
<td style="text-align: left;"> └readyTime</td>
<td style="text-align: left;">Long</td>
<td>Lesson preparation time, UNIX epoch timestamp, unit: ms</td>
<td>120000</td>
</tr>
<tr>
<td style="text-align: left;"> └extraTime</td>
<td style="text-align: left;">Long</td>
<td>Drap time, UNIX epoch timestamp, unit: ms</td>
<td>60000</td>
</tr>
<tr>
<td style="text-align: left;"> └picMonitor</td>
<td style="text-align: left;">Boolean</td>
<td>Whether to supervise class with pictures</td>
<td>false</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;"> └music</td>
<td style="text-align: left;">Integer</td>
<td>Music class mode (1-on; 0-off）</td>
<td>0</td>
</tr>
<tr>
<td style="text-align: left;"> └layout</td>
<td style="text-align: left;">Integer</td>
<td>Classroom layout mode (0 - vertical screen; 2 - horizontal screen - left and 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 on stage (2-1v1; 7-1v6）</td>
<td>7</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/booking/class/update HTTP/1.1
Host: https://neukol.axzt.net
Content-Type: application/x-www-form-urlencoded
timestamp=1598880734439&sid=5f195b1b2302bdedee4809c0&sign=bf972bbd42ef1746b3ccf24c396b4762&classroomId=5fb390e4e5e9bec6fd915eff&platformCount=7</code></pre>
<h5>Response example</h5>
<pre><code>{
"responseHeader": {
"status": 200,
"msg": "OK"
},
"response": {
"sid": "5f1140092302bd0ac2dbc7c4",
"resolutionType": "RESOLUTION_480P"
"readyTime": 120000,
"extraTime": 60000,
"picMonitor": false,
"checkMember": false,
"music": 0,
"layout": 2,
"platformCount": 7
}
}
</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>