Neukol API--EN


Add courses (batch support)

<h5>Interface introduction</h5> <p>-This interface can add new courses. The course concept can be regarded as a label of the course section in the system. It is a basic classification of the course section. The relevant attributes of the course section can be taken from the course by default. Note: the number of classes added in batch can not exceed 10</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/user_school/course/add">https://neukol.axzt.net/edu_openapi/user_school/course/add</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;">courseJson</td> <td style="text-align: left;">List<Object></td> <td style="text-align: left;">True</td> <td style="text-align: left;">Course information</td> </tr> <tr> <td style="text-align: left;"> └name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td style="text-align: left;">Course name</td> <td style="text-align: left;">Math small class</td> </tr> <tr> <td style="text-align: left;"> └folderId</td> <td style="text-align: left;">String</td> <td style="text-align: left;">False</td> <td style="text-align: left;">The icloud ID can be accessed in the lesson section. Please ensure that the icloud ID exists and can be accessed (the icloud directory is supported in the cloud disk management)</td> <td style="text-align: left;">5fb36843e5e9be1c861a67ac</td> </tr> <tr> <td style="text-align: left;"> └cloudRecord</td> <td style="text-align: left;">String</td> <td style="text-align: left;">False</td> <td style="text-align: left;">Cloud recording mode (can't coexist with local recording, only one can be enabled) resolution<em> 720p (forced cloud recording at 720p), no</em> Record (cloud recording is not allowed). Currently, all cloud recordings are recorded at 720p</td> <td style="text-align: left;">NO_RECORD</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). If it is not configured, it takes the mechanism configuration. default = 2</td> <td style="text-align: left;">2</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;">Sound mode (1-high fidelity music; 0-clear voice), not configured, take mechanism configuration, default = 0</td> <td style="text-align: left;">0</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;">Screen resolution resolution_ 480p (standard definition), resolution_720p (hd), resolution_1080p (Full HD), no fetch mechanism configuration</td> <td style="text-align: left;">resolution_480p</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;">Long</td> <td>Course ID</td> <td>true</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/user_school/courses/add HTTP/1.1 Host: https://neukol.axzt.net Content-Type: application/x-www-form-urlencoded Cookie: JSESSIONID=08225780FC74BE3AF4ADD8C6F9C9F95D Content-Length: 192 timestamp=1631773309103&amp;sign=5469324cd4bb3140155c4cbaecb0f4e6&amp;sid=6111e377e5e9be01503c65d6&amp;courseJson=[{"name":"","cloudRecord":"NO_RECORD"},{"name":"Test create course1","cloudRecord":"RESOLUTION_720P"}] </code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": { "errorDetails": [ { "name": "", "errorCode": 1033, "errorMsg": "Course name cannot be empty" } ], "successCount": 1, "failCount": 1, "successCourses": [ { "name": "Test create course", "id": 116 } ] } }</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;">321</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> <tr> <td style="text-align: left;">2218</td> <td>The number of courses added in batch exceeds 10</td> </tr> </tbody> </table>

页面列表

ITEM_HTML