獲取簽署人模板控件詳情

GET/esignglobal/v1/templates/signerFieldsDetail

接口描述

查詢模板中的簽署人控件信息。

通過合同模板編號templateId來獲取模板中設置的簽署人控件信息，後續可通過快速發起信封接口發起信封。

請求參數

參數名稱	類型	是否必填	說明
templateId	string	true	合同模板ID，可在SaaS的模板管理中查詢

請求示例

GET  https:// … …/esignglobal/v1/templates/signerFieldsDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

響應參數

參數名稱				類型	說明
templateId				string	合同模板ID
templateName				string	合同模板名稱
signerFields				array	模板中的簽署人控件列表信息
	signConfigs			array	簽署控件信息
		fieldId		string	控件ID（設置合同模板時由eSignGlobal系統自動生成）
		fieldKey		string	控件Key（設置合同模板時由用戶自定義）
		fieldType		string	控件類型： signature-簽名區 stamp-圖章區
		height		int	簽署控件高度
		width		int	簽署控件寬度
		movable		boolean	簽署時允許移動位置 false-不允許簽署人調整自己的簽署控件位置 true-允許簽署人調整自己的簽署控件位置
		posX		float	控件位置X橫坐標
		posY		float	控件位置Y縱坐標
		pageNo		string	控件所在頁碼
	fillConfigs			array	填寫控件信息
		fieldId		string	控件ID（設置合同模板時由eSignGlobal系統自動生成）
		fieldKey		string	控件Key（設置合同模板時由用戶自定義）
		fieldName		string	控件名稱
		required		boolean	是否必填 true-必填 false-非必填
		fieldsType		string	控件類型： 1-單行文本 15-勾選框
		textField		object	文本控件屬性
			overflowType	int	只對text生效 1-自動縮小字號 2-限制輸入
			minFontSize	float	只對text生效，只對overflowType=1生效。 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			width	float	控件寬度
			fontSize	float	只對text生效，字體大小 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			textColor	string	只對text生效，十六進制顏色
			bold	boolean	只對text生效，字體是否加粗 true-加粗 false-不加粗
			italic	boolean	只對text生效，是否斜體 true-斜體 false-非斜體
			underline	boolean	只對text生效，字體是否添加下劃線 true-添加下劃線 false-不添加下劃線
			lineThrough	boolean	只對text生效，是否添加刪除線 true-添加刪除線 false-不添加刪除線
			horizontalAlignment	string	只對text生效，水平居中格式 LEFT-靠左 CENTER-居中 RIGHT-靠右
		tickBoxField		object	勾選框屬性
			tickOptions	array	只對Check生效 1-勾 2-叉
		posX		float	控件位置X橫坐標
		posY		float	控件位置Y縱坐標
		pageNo		string	控件所在頁碼
	signDateConfigs			array	簽署日期信息
		fieldId		string	控件ID（設置合同模板時由eSignGlobal 系統自動生成）
		fieldKey		string	控件Key（設置合同模板時由用戶自定義）
		movable		boolean	簽署時允許移動位置 false-不允許簽署人調整自己的簽署控件位置 true-允許簽署人調整自己的簽署控件位置
		posX		float	控件位置X橫坐標
		posY		float	控件位置Y縱坐標
		pageNo		string	控件所在頁碼
		signDateFormat		string	簽署日期格式

響應示例

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"