信封中联系人新增表单项

1.描述: 信封中联系人新增表单项

2.接口地址:

请求路径：/ws-rest/v1/users/{user-id}/envelopes/{envelope-id}/recipients/forms

请求头：采用HMAC认证

请求体：

{
    "dateForms": [
        {
            "docId": "ebccc004-c3bf-4a6c-b07f-023416228bee",
            "page": 1,
            "positions": {
                "lrX": 120.1,
                "lrY": 15.6,
                "ulX": 156,
                "ulY": 250
            },
            "recipientId": 154073,
            "required": true,
            "scale": 1.2,
            "direction": "LEFT",
            "keyWords": "甲方",
            "offset": 2,
            "pages": "all",
            "data": {
                "dateData": "2016-11-04T02:13:16.420Z"
            }
        }
    ],
    "sealSignForms": [
        {
            "docId": "ebccc004-c3bf-4a6c-b07f-023416228bee",
            "page": 1,
            "positions": {
                "lrX": 250,
                "lrY": 150,
                "ulX": 190,
                "ulY": 250
            },
            "recipientId": 154073,
            "required": true,
            "scale": 1.2,
            "direction": "RIGHT",
            "keyWords": "乙方",
            "offset": 0,
            "pages": "all",
            "data": {
                "sealData": "seal data",
                "sealId": "seal id ",
                "serverSignData": {
                    "certId": "证书id",
                    "contact": "联系方式",
                    "location": "签名位置",
                    "locked": true,
                    "reason": "签名原因",
                    "renderingMode": "GRAPHIC"
                }
            }
        }
    ],
    "textForms": [
        {
            "docId": "ebccc004-c3bf-4a6c-b07f-023416228bee",
            "page": 1,
            "positions": {
                "lrX": 150,
                "lrY": 250,
                "ulX": 200,
                "ulY": 180
            },
            "recipientId": 154073,
            "required": true,
            "scale": 1.2,
            "direction": "BOTTOM",
            "keyWords": "甲方",
            "offset": 0,
            "pages": "all",
            "data": {
                "textData": "test data"
            }
        }
    ],
    "writeSignForms": [
        {
            "docId": "ebccc004-c3bf-4a6c-b07f-023416228bee",
            "page": 1,
            "positions": {
                "lrX": 120,
                "lrY": 140,
                "ulX": 220,
                "ulY": 120
            },
            "recipientId": 154073,
            "required": true,
            "scale": 1.2,
            "direction": "LEFT",
            "keyWords": "乙方",
            "offset": 0,
            "pages": "all",
            "data": {
                "serverSignData": {
                    "certId": "cert id",
                    "contact": "联系方式",
                    "location": "签名位置",
                    "locked": true,
                    "reason": "签名原因",
                    "renderingMode": "GRAPHIC"
                },
                "writeData": "手写签章数据base64",
                "writeId": "印章id"
            }
        }
    ]
}

3.请求方式

POST

4.请求参数说明

a.请求示例

curl -X POST \
--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 "{
\"dateForms\": [
{

\"docId\": \"ebccc004-c3bf-4a6c-b07f-023416228bee\",
\"page\": 1,
\"positions\": {
\"lrX\": 120.1,
\"lrY\": 15.6,
\"ulX\": 156.0,
\"ulY\": 250
},
\"recipientId\": 154073,
\"required\": true,
\"scale\": 1.2
\"data\": {
\"dateData\": \"2016-11-04T02:13:16.420Z\"
}
}
],
\"sealSignForms\": [
{
\"docId\": \"ebccc004-c3bf-4a6c-b07f-023416228bee\",
\"page\": 1,
\"positions\": {
\"lrX\": 250,
\"lrY\": 150,
\"ulX\": 190,
\"ulY\": 250
},
\"recipientId\": 154073,
\"required\": true,
\"scale\": 1.2
\"data\": {
\"sealData\": \"seal data\",
\"sealId\": \"seal id \",
\"serverSignData\": {
\"certId\": \"证书id\",
\"contact\": \"联系方式\",
\"location\": \"签名位置\",
\"locked\": true,
\"reason\": \"签名原因\",
\"renderingMode\": \"GRAPHIC\"
}
}
}
],
\"textForms\": [
{
\"docId\": \"ebccc004-c3bf-4a6c-b07f-023416228bee\",
\"page\": 1,
\"positions\": {
\"lrX\": 150,
\"lrY\": 250,
\"ulX\": 200,
\"ulY\": 180
},
\"recipientId\": 154073,
\"required\": true,
\"scale\": 1.2
\"data\": {
\"textData\": \"test data\"
}
}
],
\"writeSignForms\": [
{
\"docId\": \"ebccc004-c3bf-4a6c-b07f-023416228bee\",
\"page\": 1,
\"positions\": {
\"lrX\": 120,
\"lrY\": 140,
\"ulX\": 220,
\"ulY\": 120
},
\"recipientId\":154073,
\"required\": true,
\"scale\": 1.2
\"data\": {
\"serverSignData\": {
\"certId\": \"cert id\",
\"contact\": \"联系方式\",
\"location\": \"签名位置\",
\"locked\": true,
\"reason\": \"签名原因\",
\"renderingMode\": \"GRAPHIC\"
},
\"writeData\": \"手写签章数据base64\",
\"writeId\": \"印章id\"
}
}
]
}"
"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
docId	是	String	BODY	表单所在文档id
page	是	int	BODY	表单所在页码
positions	是	Object	BODY	当前缩放比例下表单项位置
ulX	是	float	BODY	表单元素左上角相对于与页面左上角为原点的横坐标
ulY	是	float	BODY	表单元素左上角相对于与页面左上角为原点的纵坐标
lrX	是	float	BODY	表单元素右下角相对于与页面左上角为原点的横坐标
lrY	是	float	BODY	表单元素右下角相对于与页面左上角为原点的纵坐标
recipientId	是	int	BODY	接收者id
required	是	Boolean	BODY	表单是否必填
scale	是	float	BODY	当前页面缩放比例
data	是	Object	BODY	表单项数据
dateForms	否	object	BODY	时间域
textForms	否	object	BODY	普通文本框
sealSignForms	否	Object	BODY	印章签名域
writeSignForms	否	object	BODY	手写签名域
sealData	是	String	BODY	印章64base数据
sealId	是	String	BODY	印章表单id
serverSignData	否	Object	BODY	预设签章数据
writeData	是	String	BODY	手写签名数据
writeId	是	String	BODY	手写签名域表单id
certId	是	String	BODY	证书id
contact	是	String	BODY	联系方式
location	是	String	BODY	表单项存储位置
locked	否	boolean	BODY	是否锁定
reason	否	String	BODY	签名原因
renderingMode	否	String	BODY	渲染模式GRAPHIC = ['GRAPHIC', 'DESCRIPTION', 'NAME_AND_DESCRIPTION', 'GRAPHIC_AND_DESCRIPTION']
direction	否	String	BODY	相对于关键字偏移方向(TOP、RIGHT、BOTTOM、LEFT、CENTER)
keyWords	否	String	BODY	需要定位的关键字(如果需要通过关键字定位时此字段必填，当且仅当keyWords不为null时(direction、offset、pages)有效)
offset	否	float	BODY	偏移量（单位px)
pages	否	String	BODY	待解析的页数字符串，若页数小于0，则自动置为1;若为空字符串或null，则等价于'all'。支持格式形如：'first',' last','all','odd','even','1','1-5','1,3,4,7,8',...

5.响应参数说明

a.响应示例

响应成功：

{
  "resultStatusCode": "100600000",
  "resultCode": 0,
  "resultDesc": "操作成功",
  "resultData": {
      "forms": [
          {
              "docId": "9ae474d7-15d5-4fc7-ab3f-9f1ca7cbd0d9",
              "recipientId": 803,
              "scale": 1.2,
              "positions": {
                  "ulX": 100,
                  "ulY": 150,
                  "lrX": 120,
                  "lrY": 320
              },
              "page": 1,
              "required": true,
              "data": {
                  "renderingMode": "GRAPHIC",
                  "locked": false,
                  "sealId": "string",
                  "sealData": "string"
              },
              "fieldId": 144
          },
          {
              "docId": "06de5caa-0ca0-4d18-92f3-b6cec6966d57",
              "recipientId": 803,
              "scale": 1.2,
              "positions": {
                  "ulX": 200,
                  "ulY": 120,
                  "lrX": 10,
                  "lrY": 120
              },
              "page": 1,
              "required": true,
              "data": {
                  "renderingMode": "GRAPHIC",
                  "locked": false,
                  "handwritingId": "string",
                  "handwritingData": "string"
              },
              "fieldId": 145
          },
          {
              "docId": "06de5caa-0ca0-4d18-92f3-b6cec6966d57",
              "recipientId": 802,
              "scale": 1.2,
              "positions": {
                  "ulX": 360,
                  "ulY": 450,
                  "lrX": 100,
                  "lrY": 250
              },
              "page": 1,
              "required": true,
              "data": "string",
              "fieldId": 146
          },
          {
              "docId": "9ae474d7-15d5-4fc7-ab3f-9f1ca7cbd0d9",
              "recipientId": 803,
              "scale": 1.2,
              "positions": {
                  "ulX": 260,
                  "ulY": 152,
                  "lrX": 210,
                  "lrY": 100
              },
              "page": 1,
              "required": true,
              "data": "string",
              "fieldId": 147
          }
      ]
  }
}

响应失败：

{
  "resultStatusCode": "100600102",
  "resultCode": 1,
  "resultDesc": "空信封异常"
}

b.响应字段说明

字段	必填	类型	位置	长度	说明
fieldId	是	int	BODY		表单id
recipientId	是	int	BODY		接收者id
resultStatusCode	是	String	BODY		结果状态码
resultCode	是	int	BODY	固定值	结果码
resultDesc	是	String	BODY		状态描述

添加表单

信封中联系人新增表单项

results matching ""

No results matching ""