Delete file / folder
<h5>Interface introduction</h5>
<p>To delete a folder or file, you need to provide SID, sign, timestamp, folder ID or file ID. The success description and status code are returned after success, and the corresponding error description is returned after failure.</p>
<p>Note: deleting a folder will delete all files and folders under the folder. Please use it with caution.</p>
<h5>Request 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/netdisk/delete">https://neukol.axzt.net/edu_openapi/netdisk/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;">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;">no</td>
<td style="text-align: left;">no</td>
<td style="text-align: left;">no</td>
<td>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>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">long</td>
<td style="text-align: left;">True</td>
<td>Timestamp, the timestamp within 20 minutes of the sending request time</td>
<td>1605766708325</td>
</tr>
<tr>
<td style="text-align: left;">sid</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">True</td>
<td>The unique identifier of the institution is available on the first page of API description</td>
<td>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>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>
</tr>
<tr>
<td style="text-align: left;">id</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">True</td>
<td>Folder ID or file ID to delete</td>
<td>5fb4bb551debac4ab01ff12c</td>
</tr>
</tbody>
</table>
<h5>Response 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>Description</th>
<th>Example</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">responseHeader</td>
<td style="text-align: left;">Object</td>
<td style="text-align: left;"></td>
<td>Response header information</td>
</tr>
<tr>
<td style="text-align: left;"> └status</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">True</td>
<td>HTTP response status code</td>
<td>200</td>
</tr>
<tr>
<td style="text-align: left;"> └msg</td>
<td style="text-align: left;">String</td>
<td style="text-align: left;">True</td>
<td>Return information</td>
<td>OK</td>
</tr>
<tr>
<td style="text-align: left;">response</td>
<td style="text-align: left;">bool</td>
<td style="text-align: left;">False</td>
<td>Returns. True indicates that the deletion was successful, false indicates that the deletion failed. If there is an error, this field will not be returned</td>
<td>true</td>
</tr>
</tbody>
</table>
<h5>Request example</h5>
<pre><code>POST /edu_openapi/netdisk/delete HTTP/1.1
Host: https://neukol.axzt.net/
Content-Type: application/x-www-form-urlencoded
timestamp=1605766708325&sid=5f1140092302bd0ac2dbc7c4&sign=3f1c2ca20bc24e4a4f684dd92a08dcbb&id= 5fb4bb551debac4ab01ff12c
</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;">Code value</th>
<th style="text-align: left;">Explanation</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">200</td>
<td style="text-align: left;">Delete succeeded</td>
</tr>
<tr>
<td style="text-align: left;">2101</td>
<td style="text-align: left;">Folder or file ID is empty</td>
</tr>
<tr>
<td style="text-align: left;">9994</td>
<td style="text-align: left;">Parameter format error</td>
</tr>
<tr>
<td style="text-align: left;">2000</td>
<td style="text-align: left;">sign certification failed</td>
</tr>
<tr>
<td style="text-align: left;">2001</td>
<td style="text-align: left;">Request timeout</td>
</tr>
<tr>
<td style="text-align: left;">2002</td>
<td style="text-align: left;">Institution does not open an open interface</td>
</tr>
<tr>
<td style="text-align: left;">2010</td>
<td style="text-align: left;">Institution is inexistent</td>
</tr>
<tr>
<td style="text-align: left;">500</td>
<td style="text-align: left;">unknown exception on the server</td>
</tr>
</tbody>
</table>