Neukol API--EN


Add students who have booked classes

<h5>Interface introduction</h5> <p>-To add students under the class section (students can be added in the ongoing class section), Sid, timestamp, sign, class ID and student ID array are required. The returned data is success true or failure false. It can only be used before the end of the class; Student ID must conform to the format; Can be added repeatedly; Up to 30 students in a class section; If the added students happen to have teachers of this class, the error code 2014 will appear</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/addStudents">https://neukol.axzt.net/edu_openapi/booking/class/addStudents</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;">4b12f66ed22a4b75187ecf222b3e9250</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;">1605776606537</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;">5f1119e7b1ce8d1b6327f3b1</td> </tr> <tr> <td style="text-align: left;">students</td> <td style="text-align: left;">String array</td> <td style="text-align: left;">True</td> <td style="text-align: left;">Student ID array,Add up to 30 students at a time,<br>Format 1: 3-20 digits plus character combination ID does not allow special characters to exist, which means ordinary account(like: tea00001)<br>Format 2 : country code + character’ # ‘ + mobile phone number, indicating mobile phone account number(like: 86#15751860597)</td> <td style="text-align: left;">student00001,student00002</td> </tr> </tbody> </table> <h5>Response parameter explanation</h5> <table> <thead> <tr> <th style="text-align: left;">Field 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;">&emsp;└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;">&emsp;└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;">Boolean</td> <td>True/False</td> <td>true</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/booking/class/addStudents HTTP/1.1 Host: https://neukol.axzt.net Content-Type: application/x-www-form-urlencoded sign=c03ef22bd612184e3a7d8878047f30b4&amp;classroomId=5fb61d86e5e9be63846a303f&amp;students=student00001,student00002&amp;sid=5f1140092302bd0ac2dbc7c4&amp;timestamp=1605776725165</code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": true }</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;">2004</td> <td>Classe do not exist or have been deleted</td> </tr> <tr> <td style="text-align: left;">2006</td> <td>Class section is over</td> </tr> <tr> <td style="text-align: left;">2013</td> <td>The number of students exceeds the limit of 30</td> </tr> <tr> <td style="text-align: left;">2014</td> <td>Unable to add teacher to student list</td> </tr> <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>

页面列表

ITEM_HTML