Neukol API--EN


Query account information

<h5>Interface introduction</h5> <p>-This interface can query the account information corresponding to userid</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/queryAccounts">https://neukol.axzt.net/edu_openapi/user/queryAccounts</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;">userIds</td> <td style="text-align: left;">String array</td> <td style="text-align: left;">True</td> <td style="text-align: left;">User ID array:3-20 digits plus character combination ID does not allow special characters to exist</td> <td style="text-align: left;">t24141</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;">Object</td> <td>Response body content</td> </tr> <tr> <td style="text-align: left;"> └userId</td> <td style="text-align: left;">String</td> <td>User ID:3-20 digits plus character combination ID does not allow special characters to exist.</td> <td>t12315</td> </tr> <tr> <td style="text-align: left;"> └name</td> <td style="text-align: left;">String</td> <td>User name (this name will be displayed in the class roster as one of the basis for teachers to identify students), 20 character string or less</td> <td>name Xiaoni</td> </tr> <tr> <td style="text-align: left;"> └account</td> <td style="text-align: left;">String</td> <td>Acount</td> <td>A123456789</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/user/queryAccounts HTTP/1.1 Host: https://neukol.axzt.net Content-Type: application/x-www-form-urlencoded timestamp=1598880734439&amp;sid=5f195b1b2302bdedee4809c0&amp;sign=bf972bbd42ef1746b3ccf24c396b4762userIds=teacher0011,tea00021</code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": [{ "userId": "t24141", "name": "name Xiaoni", "account": "A12312415" }] }</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>

页面列表

ITEM_HTML