标准签


修改签署流程信息

<p><strong>简要描述:</strong> </p> <ul> <li>修改签署流程信息接口(支持全量更新参与人信息)</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>http://ip:port/service/rest/v1/signflow/update</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>PUT application/json</li> </ul> <p><strong>参数:</strong> </p> <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;">flowId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>签署流程Id</td> </tr> <tr> <td style="text-align: left;">flowType</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>签署流程类型,0-自己签,1-多方顺序签,2-多方无序签,3-单独签,6-批量签</td> </tr> <tr> <td style="text-align: left;">docName</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>签署流程名称</td> </tr> <tr> <td style="text-align: left;">deadline/signDeadline</td> <td style="text-align: left;">否</td> <td style="text-align: left;">long</td> <td>签署截止日期[修改于2018-03-06,签署截止日期参数名调整为signDeadline, 目前保留deadline用于兼容支付签场景,后续会逐步移除]</td> </tr> <tr> <td style="text-align: left;">contractStartline</td> <td style="text-align: left;">否</td> <td style="text-align: left;">long</td> <td>合同有效起始时间 [添加于2018-03-06]</td> </tr> <tr> <td style="text-align: left;">contractDeadline</td> <td style="text-align: left;">否</td> <td style="text-align: left;">long</td> <td>合同有效截止时间 [添加于2018-03-06,合同有效期, 即将过期时将向参与人发送合同即将过期通知]</td> </tr> <tr> <td style="text-align: left;">description</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>备注说明</td> </tr> <tr> <td style="text-align: left;">isRealSign</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否需要实名认证签署,0-不需要, 1-需要</td> </tr> <tr> <td style="text-align: left;">payMethod</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>付费方式,0-全部发起方付,1-各自付,2-对方付(只支持双方签署的情况)</td> </tr> <tr> <td style="text-align: left;">userFolderId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>合同分类文件夹Id</td> </tr> <tr> <td style="text-align: left;">receivers</td> <td style="text-align: left;">否</td> <td style="text-align: left;">List</td> <td>参与人列表</td> </tr> <tr> <td style="text-align: left;">source</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>请求来源, 例如:’dingding’ , ’esign’ , ’esign_h5’ , ’alipay’</td> </tr> </tbody> </table> <p>参与人信息</p> <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;">account</td> <td style="text-align: left;">String</td> <td>手机号或邮箱</td> </tr> <tr> <td style="text-align: left;">nickname</td> <td style="text-align: left;">String</td> <td>姓名</td> </tr> <tr> <td style="text-align: left;">participantType</td> <td style="text-align: left;">int</td> <td>参与人类型,0-需签署,1-仅抄送</td> </tr> <tr> <td style="text-align: left;">signOrder</td> <td style="text-align: left;">int</td> <td>签署顺序</td> </tr> </tbody> </table> <p><strong>请求示例</strong></p> <pre><code> http://ip:port/service/rest/v1/signflow/update { &amp;quot;flowId&amp;quot;:&amp;quot;d27bb400-5610-4dd5-9899-d48c804a319e&amp;quot;, &amp;quot;source&amp;quot;:&amp;quot;esign&amp;quot;, &amp;quot;docName&amp;quot;:&amp;quot;整体流程测试修改信息&amp;quot;, &amp;quot;flowType&amp;quot;:1, &amp;quot;isRealSign&amp;quot;:0, &amp;quot;description&amp;quot;:&amp;quot;测试修改数据&amp;quot;, &amp;quot;payMethod&amp;quot;:0, &amp;quot;receivers&amp;quot;:[{ &amp;quot;account&amp;quot;: string, //手机号或邮箱 &amp;quot;nickname&amp;quot;: string, //姓名 &amp;quot;participantType&amp;quot;:int, //参与人类型, 0-需签署,1-仅抄送 &amp;quot;signOrder&amp;quot;:int //签署顺序 }] }</code></pre> <p><strong>返回示例</strong></p> <pre><code>{ &amp;quot;success&amp;quot;: true, &amp;quot;msg&amp;quot;: &amp;quot;成功&amp;quot;, &amp;quot;total&amp;quot;: null, &amp;quot;errCode&amp;quot;: 0, &amp;quot;errShow&amp;quot;: false, &amp;quot;data&amp;quot;: {} }</code></pre> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML