Dapatkan Butiran Templat

GET /esignglobal/v1/templates/templateDetail

Deskripsi Antara Muka

Dapatkan maklumat kawalan dalam templat.

Melalui nombor templat kontraktemplateIduntuk mendapatkan maklumat kawalan pengisian yang ditetapkan dalam templat, yang kemudiannya boleh melalui antara mukaIsi templat untuk menjana failuntuk mengisi templat.

Parameter Permintaan

Nama Parameter	Jenis	Wajib Diisi	Keterangan
templateId	string	true	ID templat kontrak, boleh didapati dalam senarai templat eSignGlobal

Contoh Permintaan

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

Parameter Respons

Nama Parameter				Jenis	Keterangan
templateId				string	ID Templat Kontrak
templateName				string	Nama Templat Kontrak
templateType				int	Jenis Templat Kontrak: 0-PDF, 1-WORD
createTime				string	Masa penciptaan templat kontrak (format cap waktu Unix, unit: milisaat)
updateTime				string	Masa kemas kini templat kontrak (format cap waktu Unix, unit: milisaat)
templateStatus				int	Status templat kontrak: 0-Tidak diaktifkan, 1-Diaktifkan
fields				array	Maklumat senarai kawalan dalam templat
	fieldId			string	ID Kawalan (dijana secara automatik oleh sistem eSignGlobal semasa menetapkan templat kontrak)
	fieldKey			string	Kunci Kawalan (ditentukan oleh pengguna semasa menetapkan templat kontrak)
	fieldName			string	Nama Kawalan
	required			boolean	Adakah kawalan wajib diisi: True-Wajib, false-Tidak wajib
	fieldType			string	1-Teks satu baris, 2-Nombor, 3-Tarikh, 8-Teks berbilang baris, 9-Semak, 10- Radio, 11- Imej, 14-Kotak juntai bawah, 15-Kotak semak
	fieldPosition			object	Maklumat lokasi kawalan (hanya templat PDF dikembalikan)
		posX		float	Koordinat X mendatar lokasi kawalan
		posY		float	Koordinat Y menegak lokasi kawalan
		posNo		int	Nombor halaman di mana kawalan berada
		movable		boolean	Benarkan menggerakkan kedudukan semasa menandatangani, lalai adalah false false-Tidak membenarkan penandatangan melaraskan kedudukan kawalan tandatangan mereka sendiri true-Membenarkan penandatangan melaraskan kedudukan kawalan tandatangan mereka sendiri
	fieldSpecialAttribute			object	Atribut unik kawalan
		dateFormat		string	Format tarikh (unik untuk kawalan tarikh)
		imageType		string	Jenis imej (unik untuk kawalan imej)
		options		array	Pilihan (Khusus untuk kawalan kotak juntai bawah, kawalan radio, kawalan berbilang pilihan)
			optionContent	string	Kandungan Pilihan
			optionOrder	int	Susunan Pilihan
			selected	boolean	Adakah pilihan dipilih secara lalai
		numberFormat		string	Format nombor (khusus untuk kawalan nombor), formatnya adalah seperti berikut: 0-integer, 0.0-kekalkan satu tempat perpuluhan, 0.00-kekalkan dua tempat perpuluhan
		tableContent		array	Kandungan baris dan lajur jadual (khusus untuk kawalan jadual dinamik), format: [row{"column1":"value1","column2":"value2"}] Keterangan tambahan: row mewakili baris yang sepadan dengan jadual dinamik, bilangan row adalah berdasarkan templat Bilangan baris yang ditambah dalam kawalan jadual dinamik. column1 mewakili nilai Key sel dalam baris semasa, value1 mewakili nilai Value sel dalam baris semasa. Jika sel tidak menetapkan nilai tetap, ia adalah rentetan kosong "", jika tidak, ia adalah nilai tetap yang ditetapkan. Lihat penjelasan tableContent untuk butiran lanjut.
		fieldMaxLength		string	Had atas panjang yang boleh diisi, unit: aksara Cina [Nota] 1 aksara Cina = 2 aksara Inggeris;
	fieldSize			object	Saiz Kawalan
		fieldWidth		float	Lebar kawalan (jarak kiri dan kanan segi empat tepat, dalam px)
		fieldHeight		float	Tinggi kawalan (jarak atas dan bawah segi empat tepat, dalam px)

Contoh Respons

{
    "code": "0",
    "data ": {
        "createTime": 1693910774808,
        "fields": [
            {
                "fieldId": "7e4bbdb838f64a31b0a4bdea18d1613c",
                "fieldKey": "",
                "fieldName": "身份证号 ",
                "fieldPosition": null,
                "fieldSize": {
                    "fieldHeight": "",
                    "fieldWidth": ""
                },
                "fieldSpecialAttribute": {
                    "dateFormat": "yyyy/MM/dd ",
                    "fieldMaxLength": "",
                    "imageType": "",
                    "numberFormat": "",
                    "options": [

                    ],
                    "tableContent": [

                    ]
                },
                "fieldType": 3,
                "required": false
            }
        ],
        "templateId": "d288b477-ed3c-4fe6-801c-80d8ec5fe9cf",
        "templateName": "test123456 ",
        "templateStatus": 0,
        "updateTime": 1693911131351
    },
    "message": "成功 "
}