修改接收者表单属性
1.描述: 修改接收者表单属性
2.接口地址:
请求路径:
ws-rest/v1/users/{user-id}/envelopes/{envelope-id}/recipients/forms
请求头:
采用HMAC认证
请求体:
{ "dateForms": [ { "fieldId": 104, "data": "2016/9/26", "docId": "1016a708-8e90-4087-9ffb-775807d963b3", "page": 1, "positions": { "ulX": 210.00002, "ulY": 213.99603, "lrX": 309.996, "lrY": 314.004 }, "recipientId": 60, "required": true, "scale": 1.2 } ], "sealSignForms": [ { "fieldId": 102, "data": { "certId": "string", "contact": "string", "data": "string", "id": "string", "location": "string", "locked": true, "reason": "string", "renderingMode": "GRAPHIC", "type": 0 }, "docId": "1016a708-8e90-4087-9ffb-775807d963b3", "page": 2, "positions": { "ulX": 210.00002, "ulY": 213.99603, "lrX": 309.996, "lrY": 314.004 }, "recipientId": 61, "required": true, "scale": 0 } ], "textForms": [ { "fieldId": 103, "data": "普通文本框", "docId": "1016a708-8e90-4087-9ffb-775807d963b3", "page": 2, "positions": { "ulX": 210.00002, "ulY": 213.99603, "lrX": 309.996, "lrY": 314.004 }, "recipientId": 62, "required": true, "scale": 1.2 } ], "writeSignForms": [ { "fieldId": 105, "data": { "certId": "string", "contact": "string", "data": "string", "id": "string", "location": "string", "locked": true, "reason": "string", "renderingMode": "GRAPHIC", "type": 0 }, "docId": "1016a708-8e90-4087-9ffb-775807d963b3", "page": 2, "positions": { "ulX": 210.00002, "ulY": 213.99603, "lrX": 309.996, "lrY": 314.004 }, "recipientId": 63, "required": true, "scale": 1.2 } ] }
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"\{
\"sealSignForms\": [
{
\"commonBaseForm\": {
\"baseForm\": {
\"docId\": \"4c1dd99e-a641-4c27-8774-4b61b3d90907\",
\"page\": 1,
\"positions\": {\"lrX\":319.1875,\"lrY\":104,\"ulX\":219.1875,\"ulY\":64},
\"recipientId\": 3223,
\"required\": true,
\"scale\": 1
},
\"fieldId\": 1702
},
\"data\": {
\"sealData\": \"1702\",
\"sealId\": \"draggedSignature4733751478142438860635435\",
\"serverSignData\": {
\"certId\": \"draggedSignature4733751478142438860635435\",
\"contact\": \"string\",
\"location\": \"string\",
\"locked\": true,
\"reason\": \"string\",
\"renderingMode\": \"GRAPHIC\"
}
}
}
]
}"
"http://10.10.10.120:8080/ws-rest/v1/users/600/envelopes/4bbd7f45-e9a9-4404-9eb0-7e87571ca6eb/recipients/forms"
b.请求字段说明
字段 | 是否必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
user-id | 是 | Long | URL-PATH | 用户id | |
envelope-id | 是 | String | URL-PATH | 信封id | |
scale | 是 | float | BODY | 当前页面缩放比例 | |
recipientId | 是 | int | BODY | 接收者id | |
docId | 是 | String | BODY | 表单所在文档id | |
page | 是 | int | BODY | 表单所在页码 | |
required | 是 | Boolean | BODY | 表单是否必填 | |
data | 否 | Object | BODY | 表单预填值 | |
positions | 是 | Object | BODY | 当前缩放比例下表单项位置 | |
ulX | 是 | float | BODY | 表单元素左上角相对于与页面左上角为原点的横坐标 | |
ulY | 是 | float | BODY | 表单元素左上角相对于与页面左上角为原点的纵坐标 | |
lrX | 是 | float | BODY | 表单元素右下角相对于与页面左上角为原点的横坐标 | |
lrY | 是 | float | BODY | 表单元素右下角相对于与页面左上角为原点的纵坐标 | |
dateForms | 否 | object | BODY | 时间域 | |
textForms | 否 | object | BODY | 普通文本框 | |
sealSignForms | 否 | Object | BODY | 印章签名域 | |
writeSignForms | 否 | object | BODY | 手写签名域 | |
certId | 是 | String | BODY | 证书id | |
contact | 否 | String | BODY | 联系方式 | |
data | 否 | String | BODY | 手写签名数据或者印章数据 | |
id | 否 | String | BODY | 手写签名id或者印章id | |
location | 否 | String | BODY | 表单项存储位置 | |
locked | 否 | boolean | BODY | 是否锁定 | |
reason | 否 | String | BODY | 签名原因 | |
renderingMode | 否 | String | BODY | 渲染模式GRAPHIC = ['GRAPHIC', 'DESCRIPTION', 'NAME_AND_DESCRIPTION', 'GRAPHIC_AND_DESCRIPTION'] |
5.响应参数说明
a.响应示例
- 响应成功:
{ "resultStatusCode": "100600000", "resultCode": 0, "resultDesc": "操作成功" }
- 响应失败:
{ "resultStatusCode": "100600107", "resultCode": 1, "resultDesc": "表单id未指定" }
b.响应字段说明
字段 | 必填 | 类型 | 位置 | 长度 | 说明 |
---|---|---|---|---|---|
resultStatusCode | 是 | String | BODY | 结果状态码 | |
resultCode | 是 | int | BODY | 固定值 | 结果码 |
resultDesc | 是 | String | BODY | 状态描述 |