协议作废
接口说明
[!NOTE]
已签署的协议作废,接口新生成一份作废协议(作废协议签署完成后自动与原合同进行关联)。获取到作废协议的APL编号,再请求获取签字链接接口生成作废协议的H5签字链接,发给用户签署作废协议,协议签署成功后,即原合同状态自动更新为 4 :作废。注:1、请求单份签合同作废,需要用作废接口中返回的作废协议编号加上原合同中每个签约人的信息分别请求接口(/v2/sign/link)获取到每个签约人的作废协议链接,每个签约人手动签署作废协议后 ,原合同状态才会更新会作废作态。
2、请求批量签署合同作废(仅适用于批量签署的合同),需要用作废接口中返回的批量业务编号加上原合同中每个签约人的信息,分别请求接口(/v2/sign/batchSignLink)获取到每个签约人的作废协议链接(注意:请求/v2/sign/batchSignLink接口时还需要加上参数dealType=20),每个签约人手动签署作废协议后 ,原合同状态才会更新会作废作态。
http请求方式
[!NOTE]
POST application/x-www-form-urlencoded
http请求地址
[!NOTE]
$SERVICE_URL/v2/sign/applySignTermination #其中$SERVICE_URL为生产或测试的地址
http请求参数
除公共必填参数外,还需要传以下参数
| 参数 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
| applyNo | string | + | 要作废的协议编号(与要作废的批量业务编号businessNo 二选一必传) | |
| businessNo | string | + | 要作废的批量签署业务编号(与要作废的协议编号applyNo 二选一必传) | |
| attachFiles | List | ? | 与要作废的协议相关的附件总大小最大 30MB | |
| reason | string | * | 作废原因,固定枚举值:合作终止 / 印章错误 / 合同条款有误 / 签约信息有误 / 其他 | |
| reasonDetail | string | * | 作废原因的详细说明,最多支持 200 个字符 | |
| authLevel | string | ? | 意愿认证方式,11为人脸识别 默认值为 无认证 | |
| noEbqSign | int | ? | 否加盖保全章 不显示ebq的保全章:1不显示但会签名,2不显示也不签名;0或其它-显示 默认为0 | |
| terminationBusinessNo | string | + | 批量作废业务编号 仅当 要作废的合同编号 为批量签编号时必填 | |
| notifyUrl | string | ? | 作废协议签署完成后异步通知地址 |
代码实现
JAVA实现
Map<String, Object> params = bodyParams;
String url = SERVICE_URL + "/v2/sign/applySignTermination";
params.put("applyNo", "APL2035920165463932928");//需要作废的APL编号
params.put("reason", "合作终止");//作废原因,固定枚举值:合作终止 / 印章错误 / 合同条款有误 / 签约信息有误 / 其他
params.put("reasonDetail", "XXXXXX");//作废原因的详细说明
String str = HttpClientUtils.init().getPost(url, null, params, true);
System.out.println(str);
http返回参数
[!NOTE]
返回response为application/json的数据,其字段说明如下
| 参数 | 类型 | 是否必返回 | 说明 |
|---|---|---|---|
| success | bool | * | 成功true;异常false |
| msg | string | ? | 异常时,返回异常原因 |
| resultCode | string | ? | 异常时返回 |
| data | string | ? | 返回值参考下方data说明 |
data参数说明
| 参数 | 类型 | 是否必返回 | 说明 |
|---|---|---|---|
| applyNo | string | * | 作废协议的APL号 |
| businessNo | string | * | 批量作废业务编号 |
| users | List | 签约方数据List,返回值参考下方users说明 |
users参数说明
| 参数 | 类型 | 是否必返回 | 说明 |
|---|---|---|---|
| fullName | string | * | 签署方名称 |
| identityCard | string | * | 签署方证件号 |
| identityType | int | * | 签署方证件类型 |
[!NOTE]
返回结果,参考:
//正确响应:
{"data":{"applyNo":"APL20XXXXX6","users":[{"fullName":"唐XX","identityCard":"5002251XXXX8","identityType":1},{"fullName":"TT测试公司","identityCard":"500XXXXXXX7","identityType":11}]},"success":true}
//错误响应:
{"msg":"签约编号或者批量签约编号不能同时为空","resultCode":"HTTP_PARAM_ERROR","success":false}