Neukol API--EN


Delete institution members (batch support)

<h5>Interface introduction</h5> <p>-This interface can delete neukol client account information of registered users in batch.</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/delete">https://neukol.axzt.net/edu_openapi/user_school/delete</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;">userJson</td> <td style="text-align: left;">List<Object></td> <td style="text-align: left;">True</td> <td style="text-align: left;">User information is passed in the JSON string format of the collection, and the maximum number of batch operations is 10</td> </tr> <tr> <td style="text-align: left;">&emsp;└phone</td> <td style="text-align: left;">String</td> <td style="text-align: left;">True</td> <td style="text-align: left;">User phone number</td> <td style="text-align: left;">t24141</td> </tr> <tr> <td style="text-align: left;">&emsp;└code</td> <td style="text-align: left;">String</td> <td style="text-align: left;">False</td> <td style="text-align: left;">The country code corresponding to the user’s mobile phone number. If it is not uploaded, it defaults to 86</td> <td style="text-align: left;">86</td> </tr> </tbody> </table> <h5>Response paramete explanation</h5> <table> <thead> <tr> <th style="text-align: left;">Parameter name</th> <th style="text-align: left;">Typr</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>Result message</td> </tr> <tr> <td style="text-align: left;">&emsp;└successCount</td> <td style="text-align: left;">Integer</td> <td>Number of successful records</td> <td>0</td> </tr> <tr> <td style="text-align: left;">&emsp;└failCount</td> <td style="text-align: left;">Integer</td> <td>Number of failed records</td> <td>1</td> </tr> <tr> <td style="text-align: left;">&emsp;└errorDetails</td> <td style="text-align: left;">List<Object></td> <td>Error details</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└phone</td> <td style="text-align: left;">String</td> <td>User phone number</td> <td>13951766666</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└code</td> <td style="text-align: left;">String</td> <td>The country code corresponding to the user’s mobile phone number</td> <td>86</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└role</td> <td style="text-align: left;">Integer</td> <td>Role</td> <td>1</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└errorMsg</td> <td style="text-align: left;">String</td> <td>Error message</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└errorCode</td> <td style="text-align: left;">Integer</td> <td>Server error code</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/user_school/delete HTTP/1.1 Host: neukol.axzt.net Content-Type: application/x-www-form-urlencoded Cookie: JSESSIONID=E111C89EEC9A5A4448FCC61927768DAC Content-Length: 207 timestamp=1631522399054&amp;sid=5f4df4846acce059dc7cc8ba&amp;sign=66c0732e3453466c25fec87d7b649b56&amp;userJson=[{"phone":"13951761234","code":"86"},{"phone":"13951762345"}]</code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": { "errorDetails": [ { "phone": "13951766666", "code": "86", "role": 1, "errorMsg": "User has been added to this institution", "errorCode": 11002 } ], "successCount": 0, "failCount": 1 } }</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> </tbody> </table>

页面列表

ITEM_HTML