Get Signer Fields Detail

GET/esignglobal/v1/templates/signerFieldsDetail

Interface Description

Get the signer fields information in the template.

Use the templateId to obtain the signer fields information set in the template, and then the envelope can be initiated through the interface Create and Start Envelope .

Request Parameter

Parameter	Type	Required	Description
templateId	string	true	Template ID, which can be queried in SaaS Template management

Request Example

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

Response Parameter

Parameter				Type	Description
templateId				string	Template ID
templateName				string	Template Name
signerFields				array	Signer Field Information in Templates
	signConfigs			array	Signing Field Information
		fieldId		string	Field ID (Automatically generated by the eSignGlobal system when setting the template.)
		fieldKey		string	Field Key (User-customized when setting the template.)
		fieldType		string	Field Type: signature-signature field stamp-stamp field approval-approval field
		sizeRule		string	Sign configs display method originalSize-Original size of stamp/signature image targetSize-Customized target size When sizeRule, height, and width are all empty, the signature/seal is rendered at its original size.
		height		int	Signing Field Height
		width		int	Signing Field Width
		movable		boolean	Allow position adjustment during signing, default:false false-Signers cannot adjust the position of their own signing fields. true-Signers can adjust the position of their own signing fields.
		allowedOptions		array	The options available for the signer's approval. Applicable when fieldType is approval. Defaults to ["approve", "decline"]. approve - Approve decline - Decline
		posX		float	X-axis coordinate
		posY		float	Y-axis coordinate
		pageNo		string	The page number of the field
	fillConfigs			array	Fill in field information
		fieldId		string	Field ID (Automatically generated by the eSignGlobal system when setting the template.)
		fieldKey		string	Field Key (User-customized when setting the template.)
		fieldName		string	Field Name
		required		boolean	Required Field: true-required false-not required
		fieldsType		string	Field Type: 1-Text 15-Check
		textField		object	Text Filed Properties
			overflowType	int	Only effective for text 1-Automatically reduce font size 2-Limit input
			minFontSize	float	Only effective for text, only for 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	Signing Field Width
			fontSize	float	Only effective for text, font size 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	Only effective for text, hexadecimal color
			bold	boolean	Only effective for text, whether the font is bold or not true-bold false-not bold
			italic	boolean	Only effective for text, italic or not true-italic false-not italic
			underline	boolean	Only effective for text, whether the font is underlined. true-underlined false-not underlined
			lineThrough	boolean	Only effective for text, whether to add strikethrough true-add strikethrough false-no strikethrough
			horizontalAlignment	string	Only effective for text, horizontally centered format LEFT-Align Left CENTER-Align center RIGHT-Align Right
		tickBoxField		object	Tick Box Properties
			tickOptions	array	Only effective for Check 1-tick 2-cross
		posX		float	X-axis coordinate
		posY		float	Y-axis coordinate
		pageNo		string	The page number of the field
	signDateConfigs			array	Signing Date Information
		fieldId		string	Field ID (Automatically generated by the eSignGlobal system when setting the template.)
		fieldKey		string	Field Key (User-customized when setting the template.)
		movable		boolean	Allow to move position when signing false-do not allow signers to adjust their own signing field position true-allow signers to adjust their own signing field position
		posX		float	X-axis coordinate
		posY		float	Y-axis coordinate
		pageNo		string	The page number of the field
		signDateFormat		string	Signing Date Format

Response Example

{
    "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"
}