Dapatkan butiran kawalan templat penandatangan

GET/esignglobal/v1/templates/signerFieldsDetail

Deskripsi Antara Muka

Pertanyaan maklumat kawalan penandatangan dalam templat.

Melalui nombor templat kontraktemplateIduntuk mendapatkan maklumat kawalan penandatangan yang ditetapkan dalam templat, yang kemudiannya boleh digunakan melaluiLancarkan sampul surat dengan cepatantara muka untuk melancarkan sampul surat.

Parameter Permintaan

Nama Parameter	Jenis	Adakah Wajib	Keterangan
templateId	string	true	ID templat kontrak, boleh ditanya dalam pengurusan templat SaaS

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Jenis	Keterangan
templateId				string	ID Templat Kontrak
templateName				string	Nama Templat Kontrak
signerFields				array	Senarai maklumat kawalan penandatangan dalam templat
	signConfigs			array	Maklumat Kawalan Penandatangan
		fieldId		string	ID Kawalan (dijana secara automatik oleheSignGlobalsistem semasa menetapkan templat kontrak)
		fieldKey		string	Kunci Kawalan (Ditetapkan oleh pengguna semasa menetapkan templat kontrak)
		fieldType		string	Jenis Kawalan: signature-Zon Tandatangan stamp-Zon Cop approval-Kawalan Kelulusan
		sizeRule		string	Cara Paparan Saiz Zon Menandatangani originalSize-Letakkan cop berdasarkan saiz sebenar tandatangan/cop targetSize-Sesuaikan lebar dan tinggi zon tandatangan/cop
		height		int	Ketinggian Kawalan Tandatangan
		width		int	Lebar Kawalan Tandatangan
		movable		boolean	Benarkan Pergerakan Lokasi Semasa Menandatangani false-Tidak membenarkan penandatangan melaraskan kedudukan kawalan tandatangan mereka sendiri true-Membenarkan penandatangan melaraskan kedudukan kawalan tandatangan mereka sendiri
		allowedOptions		array	Pilihan yang dibenarkan untuk diluluskan oleh penandatangan, sesuai untuk fieldType sebagai approval. Lalai ialah ["approve", "decline"] approve-Setuju decline-Tolak
		posX		float	Koordinat-X lokasi kawalan
		posY		float	Lokasi KawalanYKoordinat-Y
		pageNo		string	Nombor halaman kawalan berada
	fillConfigs			array	Maklumat kawalan tandatangan
		fieldId		string	ID Kawalan (dijana secara automatik oleheSignGlobalsistem semasa menetapkan templat kontrak)
		fieldKey		string	Kunci Kawalan (ditetapkan oleh pengguna semasa menetapkan templat kontrak)
		fieldName		string	Nama Kawalan
		required		boolean	Adakah Wajib Diisi true-Wajib Diisi false-Tidak Wajib Diisi
		fieldsType		string	Jenis Kawalan: 1-Teks Satu Baris 15-Kotak Semak
		textField		object	Sifat Kawalan Teks
			overflowType	int	Berkuat kuasa hanya pada teks 1-Automatik Kecilkan Saiz Fon 2-Hadkan Input
			minFontSize	float	Berkuat kuasa hanya pada teks, hanya berkuat kuasa pada 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	Lebar Kawalan
			fontSize	float	Hanya berkesan pada teks, saiz fon 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	Hanya berkesan pada teks, warna heksadesimal
			bold	boolean	Hanya berkesan pada teks, sama ada fon ditebalkan atau tidak true-Tebal false-Tidak Tebal
			italic	boolean	Hanya berkesan pada teks, sama ada condong true-Condong false-Tidak Condong
			underline	boolean	Hanya berkesan pada teks, sama ada fon digariskan true-Gariskan false-Tidak Gariskan
			lineThrough	boolean	Hanya berkesan pada teks, sama ada untuk menambah garis putus true-Tambah garis putus false-Tidak menambah garis putus
			horizontalAlignment	string	Hanya berkesan pada teks, format tengah mendatar LEFT-Jejak kiri CENTER-Tengah RIGHT-Jejak kanan
		tickBoxField		object	Atribut kotak semak
			tickOptions	array	Hanya berkesan untuk Check 1-Tanda 2-Pangkah
		posX		float	Koordinat-X mendatar kedudukan kawalan
		posY		float	Kedudukan kawalanYKoordinat menegak
		pageNo		string	Nombor halaman di mana kawalan berada
	signDateConfigs			array	Maklumat tarikh tandatangan
		fieldId		string	ID Kawalan (dijana secara automatik oleheSignGlobalsistem semasa menetapkan templat kontrak)
		fieldKey		string	Kunci Kawalan (ditentukan oleh pengguna semasa menetapkan templat kontrak)
		movable		boolean	Benarkan kedudukan dialihkan semasa menandatangani false-Tidak membenarkan penandatangan melaraskan kedudukan kawalan tandatangan mereka sendiri true-Membenarkan penandatangan melaraskan kedudukan kawalan tandatangan mereka sendiri
		posX		float	Koordinat-X lokasi kawalan
		posY		float	Lokasi kawalanYKoordinat-Y
		pageNo		string	Nombor halaman kawalan berada
		signDateFormat		string	Format tarikh tandatangan

Contoh respons

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