รับรายละเอียดการควบคุมเทมเพลตผู้ลงนาม

GET/esignglobal/v1/templates/signerFieldsDetail

คำอธิบายอินเทอร์เฟซ

สอบถามข้อมูลตัวควบคุมผู้ลงนามในเทมเพลต

ผ่านหมายเลขเทมเพลตสัญญาtemplateIdเพื่อรับข้อมูลตัวควบคุมผู้ลงนามที่ตั้งค่าไว้ในเทมเพลต จากนั้นสามารถใช้เริ่มซองจดหมายอย่างรวดเร็วอินเทอร์เฟซเพื่อเริ่มซองจดหมาย

พารามิเตอร์คำขอ

ชื่อพารามิเตอร์	ประเภท	จำเป็นหรือไม่	คำอธิบาย
templateId	string	true	ID เทมเพลตสัญญา สามารถสอบถามได้ในการจัดการเทมเพลตของ SaaS

ตัวอย่างคำขอ

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

พารามิเตอร์การตอบสนอง

ชื่อพารามิเตอร์				ประเภท	คำอธิบาย
templateId				string	ID แม่แบบสัญญา
templateName				string	ชื่อแม่แบบสัญญา
signerFields				array	ข้อมูลรายการตัวควบคุมผู้ลงนามในแม่แบบ
	signConfigs			array	ข้อมูลตัวควบคุมการลงนาม
		fieldId		string	ID ตัวควบคุม (สร้างโดยeSignGlobalระบบอัตโนมัติเมื่อตั้งค่าแม่แบบสัญญา)
		fieldKey		string	คีย์ของคอนโทรล (ผู้ใช้กำหนดเองเมื่อตั้งค่าเทมเพลตสัญญา)
		fieldType		string	ประเภทของคอนโทรล: signature- พื้นที่สำหรับเซ็นชื่อ stamp- พื้นที่สำหรับประทับตรา approval- คอนโทรลการอนุมัติ
		sizeRule		string	วิธีการแสดงขนาดพื้นที่ลงนาม originalSize- ลงตราตามขนาดจริงของลายเซ็น/ตราประทับ targetSize- กำหนดความกว้างและความสูงของพื้นที่ลายเซ็น/ตราประทับเอง
		height		int	ความสูงของส่วนควบคุมการลงนาม
		width		int	ความกว้างของส่วนควบคุมการลงนาม
		movable		boolean	อนุญาตให้ย้ายตำแหน่งเมื่อลงนาม false- ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งส่วนควบคุมการลงนามของตนเอง true- อนุญาตให้ผู้ลงนามปรับตำแหน่งส่วนควบคุมการลงนามของตนเอง
		allowedOptions		array	ตัวเลือกที่อนุญาตให้ผู้ลงนามอนุมัติ ใช้ได้กับ fieldType ที่เป็น approval ค่าเริ่มต้นคือ ["approve", "decline"] approve- อนุมัติ decline- ปฏิเสธ
		posX		float	ตำแหน่งของส่วนควบคุม พิกัด X
		posY		float	ตำแหน่งของส่วนควบคุมYพิกัด Y
		pageNo		string	หมายเลขหน้าของส่วนควบคุม
	fillConfigs			array	ข้อมูลส่วนควบคุมการลงนาม
		fieldId		string	ID ส่วนควบคุม (สร้างโดยอัตโนมัติโดยeSignGlobalระบบเมื่อตั้งค่าเทมเพลตสัญญา)
		fieldKey		string	คีย์ของส่วนควบคุม (ผู้ใช้กำหนดเองเมื่อตั้งค่าเทมเพลตสัญญา)
		fieldName		string	ชื่อส่วนควบคุม
		required		boolean	จำเป็นต้องกรอกหรือไม่ true- จำเป็นต้องกรอก false- ไม่จำเป็นต้องกรอก
		fieldsType		string	ประเภทส่วนควบคุม: 1- ข้อความบรรทัดเดียว 15- ช่องทำเครื่องหมาย
		textField		object	คุณสมบัติของตัวควบคุมข้อความ
			overflowType	int	มีผลกับข้อความเท่านั้น 1- ลดขนาดตัวอักษรโดยอัตโนมัติ 2- จำกัดการป้อนข้อมูล
			minFontSize	float	มีผลกับข้อความเท่านั้น มีผลกับ 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	ความกว้างของตัวควบคุม
			fontSize	float	มีผลกับข้อความเท่านั้น ขนาดตัวอักษร 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	มีผลกับข้อความเท่านั้น สีฐานสิบหก
			bold	boolean	มีผลกับข้อความเท่านั้น ตัวอักษรเป็นตัวหนาหรือไม่ true-ตัวหนา false-ไม่หนา
			italic	boolean	มีผลกับข้อความเท่านั้น ตัวเอียงหรือไม่ true-ตัวเอียง false-ไม่เอียง
			underline	boolean	มีผลกับข้อความเท่านั้น ขีดเส้นใต้หรือไม่ true-ขีดเส้นใต้ false-ไม่ขีดเส้นใต้
			lineThrough	boolean	มีผลเฉพาะกับข้อความ, จะเพิ่มเส้นขีดฆ่าหรือไม่ true-เพิ่มเส้นขีดฆ่า false-ไม่เพิ่มเส้นขีดฆ่า
			horizontalAlignment	string	มีผลเฉพาะกับข้อความ, รูปแบบจัดกึ่งกลางแนวนอน LEFT-ชิดซ้าย CENTER-กึ่งกลาง RIGHT-ชิดขวา
		tickBoxField		object	คุณสมบัติช่องทำเครื่องหมาย
			tickOptions	array	ใช้ได้เฉพาะกับ Check เท่านั้น 1- ติ๊ก 2- กากบาท
		posX		float	พิกัด X แนวนอนของตำแหน่งตัวควบคุม
		posY		float	ตำแหน่งตัวควบคุมYพิกัดแนวตั้ง
		pageNo		string	หมายเลขหน้าของตัวควบคุม
	signDateConfigs			array	ข้อมูลวันที่ลงนาม
		fieldId		string	ID ตัวควบคุม (สร้างโดยอัตโนมัติโดยeSignGlobalระบบเมื่อตั้งค่าเทมเพลตสัญญา)
		fieldKey		string	คีย์ตัวควบคุม (กำหนดโดยผู้ใช้เมื่อตั้งค่าเทมเพลตสัญญา)
		movable		boolean	อนุญาตให้ย้ายตำแหน่งเมื่อลงนาม false- ไม่อนุญาตให้ผู้ลงนามปรับตำแหน่งตัวควบคุมการลงนามของตนเอง true- อนุญาตให้ผู้ลงนามปรับตำแหน่งตัวควบคุมการลงนามของตนเอง
		posX		float	ตำแหน่งแกน X ของตำแหน่งวิดเจ็ต
		posY		float	ตำแหน่งวิดเจ็ตYพิกัดแกน Y
		pageNo		string	หมายเลขหน้าของวิดเจ็ต
		signDateFormat		string	รูปแบบวันที่ลงนาม

ตัวอย่างการตอบสนอง

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