Kunin ang mga detalye ng template control ng tagapirmang

GET/esignglobal/v1/templates/signerFieldsDetail

Deskripsyon ng Interface

Mag-query ng impormasyon tungkol sa mga control na may lagda sa template.

Sa pamamagitan ng ID ng template ng kontratatemplateIdupang makuha ang impormasyon tungkol sa mga control na may lagda na nakaset sa template, at pagkatapos ay maaaring gamitin angpara magsimula ng envelopeinterface upang simulan ang envelope.

Mga Parameter ng Request

Pangalan ng Parameter	Uri	Kailangan ba?	Paliwanag
templateId	string	true	ID ng Template ng Kontrata, maaaring i-query sa pamamahalaan ng template ng SaaS

Halimbawa ng Request

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

Mga Parameter ng Response

Pangalan ng Parameter				Uri	Paglalarawan
templateId				string	ID ng template ng kontrata
templateName				string	Pangalan ng template ng kontrata
documentFields				array	Talaan ng mga kontrol sa file
	fieldType			string	Talaan ng mga kontrol na may dimensyon ng file. Ginagamit upang magdagdag ng mga kontrol na may dimensyon ng file na hindi nakatali sa tagapirmahan sa isang itinakdang file.
	pageNo			string	Uri ng kontrol. Ipadala ang eMeterai para kumakatawan sa kontrol sa stamp duty ng Indonesia.
	posX			float	Numero ng pahina kung saan matatagpuan ang kontrol. Ang kontrol sa stamp duty ng Indonesia ay sumusuporta lamang sa pagtatakda ng iisang pahina; kailangan ipasa ang iisang numero ng pahina, at hindi sinusuportahan ang format ng maraming pahina tulad ng 1-3 o 1,3.
	posY			float	Offset sa x-axis, ang kaliwang ibabang sulok ng pahina ang pinagmulan ng koordinado. Ang saklaw ng koordinado ay katulad ng iba pang mga kontrol.
signerFields				array	Impormasyon ng talaan ng mga kontrol ng tagapirmahan sa template
	signConfigs			array	Impormasyon ng kontrol ng pagpirmahan
		fieldId		string	ID ng kontrol (gawa ng sistema habang inilalatag ang template ng kontrata)eSignGlobal
		fieldKey		string	Key ng kontrol (itinatakda ng gumagamit habang inilalatag ang template ng kontrata)
		fieldType		string	Uri ng kontrol: signature-Lugar ng lagda stamp-Lugar ng tatak approval-Kontrol para sa pag-apruba
		required		boolean	Kailangan ba, default ay kailangan true-Kailangan false-Hindi kailangan
		sizeRule		string	Paraan ng pagpapakita ng sukat ng lugar ng pag-sign originalSize-Ayon sa aktwal na sukat ng lagda/tatak targetSize-Custom na lapad at taas ng lugar ng lagda/tatak
		height		int	Taas ng kontrol para sa pag-sign
		width		int	Lapad ng kontrol para sa pag-sign
		movable		boolean	Payagan ang paggalaw ng posisyon habang nagse-sign false-Hindi pinapayagan ang taga-sign na baguhin ang posisyon ng kanyang sariling kontrol para sa pag-sign true-Pinapayagan ang taga-sign na baguhin ang posisyon ng kanyang sariling kontrol para sa pag-sign
		allowedOptions		array	Opsyon na pinapayagan ang taga-sign na mag-apruba, para sa fieldType na approval. Default ay ["approve", "decline"] approve-Tanggapin decline-Tanggihan
		posX		float	X-coordinate ng posisyon ng kontrol
		posY		float	Posisyon ng kontrolYY-coordinate
		pageNo		string	Pahina kung saan matatagpuan ang kontrol
	fillConfigs			array	Impormasyon ng kontrol para sa pag-sign
		fieldId		string	ID ng kontrol (awtomatikong ginawa ng sistema kapag inilala ang template ng kontrata)eSignGlobal
		fieldKey		string	Key ng kontrol (na-customize ng user kapag inilala ang template ng kontrata)
		fieldName		string	Pangalan ng kontrol
		required		boolean	Kailangan ba ito? true-Required false-Hindi required
		fieldsType		string	Uri ng kontrol: 1-Tekstong isahan ang linya 15-Checkbox
		textField		object	Mga katangian ng text control
			overflowType	int	Gumagana lamang para sa text 1-Awtomatikong bawasan ang laki ng font 2-Limitahan ang input
			minFontSize	float	Gumagana lamang para sa text, at gumagana lamang kapag 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	Lapad ng control
			fontSize	float	Gumagana lamang para sa text, laki ng font 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	Gumagana lamang para sa text, hexadecimal na kulay
			bold	boolean	Gumagana lamang para sa text, kung bold ba ang font true-Bold false-Hindi bold
			italic	boolean	Gumagana lamang para sa text, kung italic ba true-Italic false-Hindi matalik
			underline	boolean	Epektibo lamang sa text, kung may underline ang font true-Magdagdag ng underline false-Huwag magdagdag ng underline
			lineThrough	boolean	Epektibo lamang sa text, kung may strikethrough true-Magdagdag ng strikethrough false-Huwag magdagdag ng strikethrough
			horizontalAlignment	string	Epektibo lamang sa text, pagsasaayos ng horizontal na pag-aayos sa gitna LEFT-I-align sa kaliwa CENTER-I-center RIGHT-I-align sa kanan
		tickBoxField		object	Mga katangian ng checkbox
			tickOptions	array	Epektibo lamang sa Check 1-Check mark 2-X
		posX		float	X-coordinate ng posisyon ng kontrol
		posY		float	Posisyon ng kontrolYY-coordinate
		pageNo		string	Numero ng pahina kung saan matatagpuan ang kontrol
	signDateConfigs			array	Impormasyon tungkol sa petsa ng pag-sign
		fieldId		string	ID ng kontrol (awtomatikong ginawa ng sistema habang inilala ang template ng kontrata)eSignGlobal
		fieldKey		string	Key ng kontrol (customized ng user habang inilala ang template ng kontrata)
		movable		boolean	Pinapayagan na ilipat ang posisyon habang nagse-sign false-Hindi pinapayagan ang tagapagsign na baguhin ang posisyon ng kanyang sariling kontrol sa pag-sign true-Pinapayagan ang tagapagsign na baguhin ang posisyon ng kanyang sariling kontrol sa pag-sign
		posX		float	X-coordinate ng posisyon ng kontrol
		posY		float	Posisyon ng kontrolYY-coordinate
		pageNo		string	Numero ng pahina kung saan matatagpuan ang kontrol
		signDateFormat		string	Formato ng Petsa ng Pagpirma

Halimbawa ng Tugon

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