Neukol API--EN


Query institution icloud information

<h5>interface introduction</h5> <ul> <li>Query information such as the ownership of institutional cloud disk and the used capacity of institutional cloud disk.</li> </ul> <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/info">https://neukol.axzt.net/edu_openapi/school/info</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;">Parameter name</th> <th style="text-align: left;">Required</th> <th style="text-align: left;">Type</th> <th>Explanation</th> </tr> </thead> <tbody> </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: center;">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: center;">InstitutionID</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: center;">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: center;">Unix Epoch timestamp within 20 minutes of current calling interface, unit: milliseconds</td> <td style="text-align: left;">1600140360000</td> </tr> </tbody> </table> <h5>Response patemeter</h5> <table> <thead> <tr> <th style="text-align: left;">Parameter name</th> <th style="text-align: left;">Required</th> <th style="text-align: left;">Type</th> <th>Explanation</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sid</td> <td style="text-align: left;">True</td> <td style="text-align: left;">string</td> <td>Institution account</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">True</td> <td style="text-align: left;">string</td> <td>Institution name</td> </tr> <tr> <td style="text-align: left;">netDiskInfo</td> <td style="text-align: left;">True</td> <td style="text-align: left;">string</td> <td>icloud information</td> </tr> <tr> <td style="text-align: left;">netDiskInfo</td> <td style="text-align: left;">True</td> <td style="text-align: left;">string</td> <td>icloud information</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└ownedStorage</td> <td style="text-align: left;">True</td> <td style="text-align: left;">integer</td> <td>Space owned by institutional icloud (unit: MB)</td> </tr> <tr> <td style="text-align: left;">&emsp;&emsp;└usedStorage</td> <td style="text-align: left;">True</td> <td style="text-align: left;">integer</td> <td>Used space of organization icloud (unit: MB)</td> </tr> </tbody> </table> <h5>Request example</h5> <pre><code>POST /edu_openapi/school/info HTTP/1.1 Host: neukol.axzt.net Content-Type: application/x-www-form-urlencoded Cookie: JSESSIONID=B02738AEFE658DE8C1247AC605CF4F0F Content-Length: 90 timestamp=1621840355152&amp;sid=5f4df4846acce059dc7cc8ba&amp;sign=5b98198f391566f740f723c3b2b45803</code></pre> <h5>Response example</h5> <pre><code>{ "responseHeader": { "status": 200, "msg": "OK" }, "response": { "id": "5f4df4846acce059dc7cc8ba", "name": "Demonstration institution", "netDiskInfo": { "ownedStorage": 204800, "usedStorage": 553 } } }</code></pre> <h5>Error code</h5> <table> <thead> <tr> <th style="text-align: left;">Code value</th> <th style="text-align: left;">Explanation</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">321</td> <td style="text-align: left;">Required input parameter missing</td> </tr> </tbody> </table>

页面列表

ITEM_HTML