协议信息接口-广爱推送蓝海
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>店信息接口-推送</li>
</ul>
<h5>请求URL</h5>
<ul>
<li>测试环境 <code>https://gaapi.dixingps.cn/web/gaib/api/agreementInfo</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<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;">Authorization</td>
<td style="text-align: left;">是</td>
<td>Bearer a7fe162f-2b74-4800-9516-ca8b4567a422</td>
</tr>
</tbody>
</table>
<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;">list</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">array</td>
<td>列表</td>
</tr>
</tbody>
</table>
<h5>list参数</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;">agreementNo</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>协议编号</td>
</tr>
<tr>
<td style="text-align: left;">shopCode</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>店铺</td>
</tr>
<tr>
<td style="text-align: left;">finId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>金融机构id</td>
</tr>
<tr>
<td style="text-align: left;">finName</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>金融机构名称</td>
</tr>
<tr>
<td style="text-align: left;">isLocked</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>是否启用empty：0：启用 1：禁用</td>
</tr>
<tr>
<td style="text-align: left;">signDt</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>签订时间</td>
</tr>
<tr>
<td style="text-align: left;">validDt</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>有效期限</td>
</tr>
<tr>
<td style="text-align: left;">superviseKey</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>监管钥匙 0：不监管 1：监管一把 2：监管全套</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>{
"list":[
{
"agreementNo": "中信1112022122901",
"shopCode": "AHB3000",
"finId": 3,
"finName": "中国银行",
"isLocked":1,
"signDt":"2022-12-20",
"validDt":"2024-12-20",
"superviseKey":1,
},
{
"agreementNo": "中行南沙33J202022120101",
"shopCode": "33J20",
"finId": 14,
"finName": "中国银行股份有限公司广东自贸试验区南沙分行",
"isLocked":0,
"signDt":"2022-12-20",
"validDt":"2025-12-20",
"superviseKey":2,
}
]
}</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;">boolean</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;">message</td>
<td style="text-align: left;">string</td>
<td>失败说明</td>
</tr>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">int</td>
<td>状态码</td>
</tr>
</tbody>
</table>
<h5>成功返回示例</h5>
<pre><code>{
"success": true,
"data": "操作成功",
"message": null,
"code": 200,
"includes": null,
"excludes": null,
"onlyData": false,
"callback": null
}</code></pre>
<h5>失败返回示例</h5>
<pre><code>{
"success": false,
"data": null,
"message": "接口尚未开发",
"code": 500,
"includes": null,
"excludes": null,
"onlyData": false,
"callback": null
}</code></pre>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>