Dapatkan butiran kawalan templat penandatangan

GET/esignglobal/v1/templates/signerFieldsDetail

Penerangan Antara Muka

Maklumat kawalan penandatangan dalam templat.

Melalui ID templat kontraktemplateIduntuk mendapatkan maklumat kawalan penandatangan yang ditetapkan dalam templat, seterusnya boleh melaluiantara muka untuk memulakan sampul surat.

Parameter Permintaan

Nama Parameter	Jenis	Wajib	Keterangan
templateId	string	true	ID Templat Kontrak, boleh disemak dalam pengurusan templat SaaS

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Jenis	Penerangan
templateId				string	ID Templat Kontrak
templateName				string	Nama Templat Kontrak
documentFields				array	Senarai Kawalan Fail
	fieldType			string	Senarai kawalan dimensi fail. Digunakan untuk menambah kawalan dimensi fail yang tidak mengikat penandatangan pada fail yang ditentukan.
	pageNo			string	Jenis kawalan. Hantar eMeterai untuk menunjukkan kawalan cukai meterai Indonesia.
	posX			float	Nombor halaman di mana kawalan tersebut berada. Kawalan cukai meterai Indonesia hanya menyokong penetapan satu halaman sahaja, jadi perlu memasukkan nombor halaman tunggal; format berbilang halaman berterusan atau tidak berterusan seperti 1-3 atau 1,3 tidak disokong.
	posY			float	Anjakan paksi-x, dengan titik asal koordinat di sudut kiri bawah halaman. Julat koordinat adalah sama dengan julat koordinat kawalan lain.
signerFields				array	Maklumat senarai kawalan penandatangan dalam templat
	signConfigs			array	Maklumat kawalan penandatangan
		fieldId		string	ID Kawalan (dijana secara automatik oleh sistem semasa menetapkan templat kontrak)eSignGlobal
		fieldKey		string	Kunci Kawalan (ditentukan sendiri oleh pengguna semasa menetapkan templat kontrak)
		fieldType		string	Jenis Kawalan: signature-Kawasan tandatangan stamp-Kawasan cap approval-Kawalan kelulusan
		required		boolean	Adakah ia diperlukan, secara lalai diperlukan true-Diperlukan false-Tidak diperlukan
		sizeRule		string	Cara paparan saiz kawasan penandatanganan originalSize-Letakkan berdasarkan saiz sebenar tandatangan/cap targetSize-Tentukan lebar dan tinggi kawasan tandatangan/cap secara tersuai
		height		int	Ketinggian kawalan penandatanganan
		width		int	Lebar kawalan penandatanganan
		movable		boolean	Benarkan pergerakan semasa menandatangani false-Penandatangan tidak dibenarkan menyesuaikan kedudukan kawalan penandatanganan sendiri true-Penandatangan dibenarkan menyesuaikan kedudukan kawalan penandatanganan sendiri
		allowedOptions		array	Pilihan yang membenarkan penandatangan meluluskan, sesuai untuk fieldType approval. Secara lalai adalah ["approve", "decline"] approve-Setuju decline-Tolak
		posX		float	Koordinat-X kedudukan kawalan
		posY		float	Kedudukan kawalanYKoordinat-Y
		pageNo		string	Nombor halaman tempat kawalan berada
	fillConfigs			array	Maklumat widget penandatangan
		fieldId		string	ID widget (dijana secara automatik oleh sistem semasa menetapkan templat kontrak)eSignGlobal
		fieldKey		string	Key widget (ditakrifkan sendiri oleh pengguna semasa menetapkan templat kontrak)
		fieldName		string	Nama widget
		required		boolean	Adakah ia diperlukan true-Wajib diisi false-Tidak wajib diisi
		fieldsType		string	Jenis widget: 1-Teks satu baris 15-Petak semak
		textField		object	Atribut kawalan teks
			overflowType	int	Hanya berkesan untuk teks 1-Auto mengecilkan saiz fon 2-Had input
			minFontSize	float	Hanya berkesan untuk teks, hanya berkesan apabila 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 untuk 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 untuk teks, warna heksadesimal
			bold	boolean	Hanya berkesan untuk teks, sama ada fon tebal atau tidak true-Tebal false-Tidak tebal
			italic	boolean	Hanya berkesan untuk teks, sama ada fon condong atau tidak true-Condong false-Tidak miring
			underline	boolean	Hanya berkuat ke atas text, sama ada garis bawah ditambahkan pada fon true-Tambahkan garis bawah false-Jangan tambahkan garis bawah
			lineThrough	boolean	Hanya berkuat ke atas text, sama ada garis coretan ditambahkan true-Tambahkan garis coretan false-Jangan tambahkan garis coretan
			horizontalAlignment	string	Hanya berkuat ke atas text, format tengah mendatar LEFT-Kiri CENTER-Tengah RIGHT-Kanan
		tickBoxField		object	Atribut kotak semak
			tickOptions	array	Hanya berkuat ke atas Check 1-Tanda centang 2-Tanda silang
		posX		float	Koordinat X kedudukan kawalan
		posY		float	Kedudukan kawalanYKoordinat Y
		pageNo		string	Nombor halaman tempat kawalan berada
	signDateConfigs			array	Maklumat tarikh penandatanganan
		fieldId		string	ID kawalan (dijana secara automatik oleh sistem semasa menetapkan templat kontrak)eSignGlobal
		fieldKey		string	Key kawalan (ditentukan sendiri oleh pengguna semasa menetapkan templat kontrak)
		movable		boolean	Membolehkan kedudukan diubah semasa menandatangani false- Penandatangan tidak dibenarkan menyesuaikan kedudukan kawalan penandatanganan mereka sendiri true- Penandatangan dibenarkan menyesuaikan kedudukan kawalan penandatanganan mereka sendiri
		posX		float	Koordinat X kedudukan kawalan
		posY		float	Kedudukan kawalanYKoordinat Y
		pageNo		string	Nombor halaman tempat 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"
}