API接口报文说明
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>获取信息列表接口通用描述</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>https://api.in-school.cn/api/datainterface/{method}/{uuid}/{schoolorgid}</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>GET </li>
</ul>
<h5>参数</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">method</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>接口方法</td>
</tr>
<tr>
<td style="text-align: left;">uuid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>接入用户名，由接入方提供</td>
</tr>
<tr>
<td style="text-align: left;">schoolorgid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>校区ID，通过校区列表查询获得，再按校区轮询查询</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code>{
&quot;success&quot;: true,
&quot;code&quot;: 0,
&quot;message&quot;: &quot;string&quot;,
&quot;data&quot;: &quot;string&quot;,
&quot;extras&quot;: &quot;string&quot;,
&quot;timestamp&quot;: 0
}
</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">success</td>
<td style="text-align: left;">bool</td>
<td>请求结果</td>
</tr>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">int</td>
<td>请求结果码，0为成功</td>
</tr>
<tr>
<td style="text-align: left;">message</td>
<td style="text-align: left;">string</td>
<td>请求结果描述</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">string</td>
<td>请求返回的数据（密文）</td>
</tr>
<tr>
<td style="text-align: left;">extras</td>
<td style="text-align: left;">string</td>
<td>请求额外数据</td>
</tr>
<tr>
<td style="text-align: left;">timestamp</td>
<td style="text-align: left;">int</td>
<td>请求时间</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>data 为请求返回的结果，此结果数据为加密数据，采用国密SM4加密算法，密钥由接入方提供，解密后的数据为json字符串，具体说明请参考接口方法说明</li>
</ul>
<p><strong>解密密钥由接入方提供</strong></p>
<p>SM4加密算法参考：<a href="https://www.btool.cn/sm4">https://www.btool.cn/sm4</a></p>
<p>参考以下参数：</p>
<p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=20adc1356a2dbfdc07a335dff7098946&amp;file=file.png" alt="" /></p>