更新信封基本信息
1.描述: 用户进行注册
2.接口地址:
请求路径:
/ws-rest/v1/users/{user-id}/envelopes/{envelope-id}/basic-info
请求头:
采用HMAC认证
请求体:
{ "expiratioWarn": 10, "expiration": "2017-03-22T01:25:54.266Z", "expirationEnabled": true, "secureLevel": 0, "subject": "省工商合同标识", "title": "envelope title" }
3.请求方式
PUT
4.请求参数说明
a.请求示例
curl -X PUT\
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Date: Wed, 02 Nov 2016 03:25:54 GMT" \
--header "User-Agent: SignIt RestAPI Client v1.0.0" \
--header "Host: api.signit.cn" \
--header "Authorization:HmacSHA512 a1S0H2-U0-v5I-0586-017-z6D-7B5-K0h-1o0-G0-9923G3Xm:53f7ae4a-937b-4ddc-8872-42dd094d56eb:NCMwvHfZS9ZzB2SgVbRzTuS/N5yDRM8Ak6tRvCavHD5T9nKjydc9ha+Rj48e0YIFC5V9IRtFL8Z1d0hvse7Ulg==" \
-d \
"{
\"expiratioWarn\": 10,
\"expiration\": \"2017-03-22T01:25:54.266Z\",
\"expirationEnabled\": true,
\"secureLevel\": 0,
\"subject\": \"envelope subject\",
\"title\": \"envelope title\"
}" "http://10.10.10.120:8080/ws-rest/v1/users/1834/envelopes/48394735-588b-4ac0-ac28-39fc8105484d/basic-info"
b.请求字段说明
字段 | 是否必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
user-id | 是 | Long | URL-PATH | 用户id | |
envelope-id | 是 | String | URL-PATH | 信封id | |
title | 否 | String | 请求体 | 信封标题 | |
subject | 否 | String | 请求体 | 信封主题 | |
secureLevel | 否 | int | 请求体 | 证书安全级别(1:一次性证书,2:商用证书,3:平台证书) | |
expirationEnabled | 否 | boolean | 请求体 | 信封是否长期有效 | |
expiration | 否 | int | 请求体 | 过期时间 | |
expirationWarn | 否 | int | 请求体 | 过期前多久进行提醒 |
5.响应参数说明
a.响应示例
- 响应成功:
{ "resultStatusCode": "100600000", "resultCode": 0, "resultDesc": "更新信封成功" }
- 响应失败:
{ "resultStatusCode": "100600113", "resultCode": 1, "resultDesc": "当前信封状态禁止更新" }
b.响应字段说明
字段 | 必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
resultStatusCode | 是 | string | BODY | 固定值 | 结果状态码 |
resultCode | 是 | int | BODY | 固定值-0,1 | 结果码,0-成功,1-失败,具体含义见结果状态码 |
resultDesc | 是 | string | BODY | 无 | 操作结果说明,见其包含信息 |