方糖APP管理台接口(二维码)
<h1>1 二维码</h1>
<h2>1.1 查询所有二维码</h2>
<ul>
<li><strong>后台逻辑</strong>
<ul>
<li>查询条件:银行号(当前登录用户所属银行)、机构号(从请求中获取,默认为当前登录用户机构),二维码名称(模糊查询),二维码状态,渠道简称</li>
<li>排序条件:创建时间(倒序desc)</li>
</ul></li>
<li><strong>前端逻辑</strong>:
<ul>
<li>查询条件:二维码名称(输入框),二维码状态(下拉框),系统简称(下拉框选择);</li>
<li>页面操作:查询条件输入,查询条件清空,查询;</li>
</ul></li>
</ul>
<h3>1.1.1 接口描述</h3>
<p>二维码的查询和条件查询</p>
<h3>1.1.2 接口地址</h3>
<pre><code class="language-java">http://10.189.17.80:9092/sugar-management/api/{channel}/code/list</code></pre>
<h3>1.1.3 请求报文</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>channel</td>
<td>string</td>
<td>N</td>
<td>系统简称</td>
</tr>
<tr>
<td>codeName</td>
<td>string</td>
<td>N</td>
<td>二维码名称</td>
</tr>
<tr>
<td>codeStatus</td>
<td>String</td>
<td>N</td>
<td>二维码状态(0.正常,1.下架)</td>
</tr>
</tbody>
</table>
<h3>1.1.4 请求样例</h3>
<pre><code class="language-javascript">{
"bankNo":"1001",
"instNo":"1001",
"channel":"APP",
"codeName":"小程序名称",
"codeStatus": "0"
}</code></pre>
<h3>1.1.5 响应报文data</h3>
<p>小程序信息数组,数组中数据结构</p>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>codeId</td>
<td>String</td>
<td>小程序Id</td>
</tr>
<tr>
<td>bankNo</td>
<td>String</td>
<td>银行号</td>
</tr>
<tr>
<td>instNo</td>
<td>String</td>
<td>机构号</td>
</tr>
<tr>
<td>channel</td>
<td>String</td>
<td>渠道简称</td>
</tr>
<tr>
<td>codeName</td>
<td>String</td>
<td>二维码名称</td>
</tr>
<tr>
<td>codeUrl</td>
<td>String</td>
<td>二维码URL</td>
</tr>
<tr>
<td>codeIcon</td>
<td>String</td>
<td>二维码图标</td>
</tr>
<tr>
<td>codeStatus</td>
<td>String</td>
<td>二维码状态</td>
</tr>
<tr>
<td>createTime</td>
<td>String</td>
<td>创建时间述</td>
</tr>
<tr>
<td>createUser</td>
<td>String</td>
<td>创建人</td>
</tr>
<tr>
<td>updateTime</td>
<td>String</td>
<td>更新时间</td>
</tr>
<tr>
<td>updateUser</td>
<td>String</td>
<td>更新人</td>
</tr>
</tbody>
</table>
<h3>1.1.6 响应样例</h3>
<pre><code></code></pre>
<h2>1.2 单个二维码信息查询</h2>
<h3>1.2.1功能详细设计</h3>
<ul>
<li><strong>后台逻辑</strong>:
<ul>
<li>查询条件:根据Id来查询二维码详细信息;</li>
</ul></li>
<li><strong>前端逻辑</strong>:
<ul>
<li>选中时(修改)查看二维码详细信息</li>
</ul></li>
</ul>
<h3>1.2.2 接口描述</h3>
<p>根据Id查询二维码信息</p>
<h3>1.2.3 接口地址</h3>
<pre><code class="language-java">http://10.189.17.80:9092/sugar-management/api/{channel}/code/info</code></pre>
<h3>1.2.4 请求报文</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>codeId</td>
<td>String</td>
<td>Y</td>
<td>二维码ID</td>
</tr>
</tbody>
</table>
<h3>1.2.5 请求样例</h3>
<pre><code class="language-javascript">{
"codeId":"1001"
}</code></pre>
<h3>1.2.6 响应报文data</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>codeId</td>
<td>String</td>
<td>小程序Id</td>
</tr>
<tr>
<td>bankNo</td>
<td>String</td>
<td>银行号</td>
</tr>
<tr>
<td>instNo</td>
<td>String</td>
<td>机构号</td>
</tr>
<tr>
<td>channel</td>
<td>String</td>
<td>渠道简称</td>
</tr>
<tr>
<td>codeName</td>
<td>String</td>
<td>二维码名称</td>
</tr>
<tr>
<td>codeUrl</td>
<td>String</td>
<td>二维码URL</td>
</tr>
<tr>
<td>codeIcon</td>
<td>String</td>
<td>二维码图标</td>
</tr>
<tr>
<td>codeStatus</td>
<td>String</td>
<td>二维码状态</td>
</tr>
<tr>
<td>codeDesc</td>
<td>String</td>
<td>二维码描述</td>
</tr>
<tr>
<td>createTime</td>
<td>String</td>
<td>创建时间述</td>
</tr>
<tr>
<td>createUser</td>
<td>String</td>
<td>创建人</td>
</tr>
<tr>
<td>updateTime</td>
<td>String</td>
<td>更新时间</td>
</tr>
<tr>
<td>updateUser</td>
<td>String</td>
<td>更新人</td>
</tr>
</tbody>
</table>
<h3>1.2.7 响应样例</h3>
<pre><code></code></pre>
<h2>1.3 二维码新增</h2>
<h3>1.3.1 功能详细设计</h3>
<ul>
<li><strong>后台逻辑</strong>:
<ul>
<li>后台生成二维码id,前端不用传值</li>
<li>银行号和机构号默认为登录用户</li>
<li>保存至数据库返回给前端状态信息
<h3>1.3.2 接口描述</h3></li>
</ul></li>
</ul>
<p>新增二维码信息</p>
<h3>1.3.3 接口地址</h3>
<pre><code class="language-java">http://10.189.17.80:9092/sugar-management/api/{channel}/code/add</code></pre>
<h3>1.3.4 请求报文</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>codeId</td>
<td>String</td>
<td>N</td>
<td>程序Id</td>
</tr>
<tr>
<td>channel</td>
<td>String</td>
<td>Y</td>
<td>渠道简称</td>
</tr>
<tr>
<td>codeName</td>
<td>String</td>
<td>Y</td>
<td>二维码名称</td>
</tr>
<tr>
<td>codeUrl</td>
<td>String</td>
<td>Y</td>
<td>二维码URL</td>
</tr>
<tr>
<td>codeIcon</td>
<td>String</td>
<td>Y</td>
<td>维码图标</td>
</tr>
<tr>
<td>codeStatus</td>
<td>String</td>
<td>Y</td>
<td>二维码状态</td>
</tr>
<tr>
<td>codeDesc</td>
<td>String</td>
<td>N</td>
<td>二维码描述</td>
</tr>
</tbody>
</table>
<h3>1.3.5 请求样例</h3>
<pre><code></code></pre>
<h3>1.3.6 响应报文data</h3>
<p>无</p>
<h3>1.3.7 响应样例</h3>
<pre><code></code></pre>
<h2>1.4 修改二维码信息</h2>
<h3>1.4.1 功能详细设计</h3>
<ul>
<li>后台逻辑:
<ul>
<li>逻辑概述:根据codeId修改用户信息</li>
<li>字段校验:参考1.4.4请求报文</li>
</ul></li>
</ul>
<h3>1.4.2 接口描述</h3>
<p>修改二维码信息</p>
<h3>1.4.3 接口地址</h3>
<pre><code class="language-java">http://10.189.17.80:9092/sugar-management/api/{channel}/code/modify</code></pre>
<h3>1.4.4 请求报文</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>codeId</td>
<td>String</td>
<td>Y</td>
<td>程序Id</td>
</tr>
<tr>
<td>channel</td>
<td>String</td>
<td>N</td>
<td>渠道简称</td>
</tr>
<tr>
<td>codeName</td>
<td>String</td>
<td>N</td>
<td>二维码名称</td>
</tr>
<tr>
<td>codeUrl</td>
<td>String</td>
<td>N</td>
<td>二维码URL</td>
</tr>
<tr>
<td>codeIcon</td>
<td>String</td>
<td>N</td>
<td>二维码图标</td>
</tr>
<tr>
<td>codeStatus</td>
<td>String</td>
<td>N</td>
<td>二维码状态</td>
</tr>
<tr>
<td>codeDesc</td>
<td>String</td>
<td>N</td>
<td>二维码描述</td>
</tr>
</tbody>
</table>
<h3>1.4.5 请求样例</h3>
<pre><code></code></pre>
<h3>1.4.6 响应报文data</h3>
<p>无</p>
<h3>1.4.7 响应样例</h3>
<pre><code></code></pre>
<h2>1.5 删除二维码信息</h2>
<h3>1.5.1 功能详细设计</h3>
<ul>
<li><strong>后台逻辑</strong>:
<ul>
<li>逻辑概述:根据codeId删除二维码信息</li>
<li>字段校验:参考1.5.4请求报文</li>
<li>保存至数据库返回给前端状态信息(200、500);</li>
</ul></li>
<li><strong>前端逻辑</strong>:
<ul>
<li>选中进行删除</li>
</ul></li>
</ul>
<h3>1.5.2 接口描述</h3>
<p>删除二维码信息</p>
<h3>1.5.3 接口地址</h3>
<pre><code class="language-java">http://10.189.17.80:9092/sugar-management/api/{channel}/code/remove</code></pre>
<h3>1.5.4 请求报文</h3>
<table>
<thead>
<tr>
<th>参数</th>
<th>类型</th>
<th>必填</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>codeId</td>
<td>String</td>
<td>Y</td>
<td>二维码ID</td>
</tr>
</tbody>
</table>
<h3>1.6.5 请求样例</h3>
<pre><code class="language-javascript">{
"codeId":"1001"
}</code></pre>
<h3>1.6.7 响应样例</h3>
<pre><code></code></pre>