รับรายละเอียดของคอนโทรลแม่แบบผู้ลงนาม

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	ชื่อแม่แบบสัญญา
documentFields				array	รายการคอนโทรลไฟล์
	fieldType			string	รายการคอนโทรลมิติไฟล์บนไฟล์ ใช้เพื่อเพิ่มคอนโทรลมิติไฟล์ที่ไม่ผูกกับผู้ลงนามบนไฟล์ที่กำหนด
	pageNo			string	ประเภทคอนโทรล ส่ง eMeterai เพื่อแสดงคอนโทรลภาษีอากรของอินโดนีเซีย
	posX			float	หมายเลขหน้าของคอนโทรล คอนโทรลภาษีอากรของอินโดนีเซียรองรับเฉพาะการระบุหน้าเดียว ต้องส่งหมายเลขหน้าเดียว ไม่รองรับรูปแบบหลายหน้าต่อเนื่องหรือไม่ต่อเนื่อง เช่น 1-3, 1,3 เป็นต้น
	posY			float	ค่าเบี่ยงเบนแกน x จุดกำเนิดพิกัดอยู่ที่มุมล่างซ้ายของหน้า ขอบเขตพิกัดสอดคล้องกับขอบเขตพิกัดของคอนโทรลอื่น ๆ
signerFields				array	ข้อมูลรายการคอนโทรลผู้ลงนามในแม่แบบ
	signConfigs			array	ข้อมูลคอนโทรลการลงนาม
		fieldId		string	ID ของคอนโทรล (ระบบสร้างอัตโนมัติเมื่อตั้งค่าแม่แบบสัญญา)eSignGlobal
		fieldKey		string	Key ของคอนโทรล (ผู้ใช้กำหนดเองเมื่อตั้งค่าแม่แบบสัญญา)
		fieldType		string	ประเภทคอนโทรล: signature-พื้นที่ลายเซ็น stamp-พื้นที่ตราประทับ approval-คอนโทรลการอนุมัติ
		required		boolean	เป็นค่าบังคับหรือไม่ ค่าเริ่มต้นคือบังคับ true-บังคับ false-ไม่บังคับ
		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	Key ของคอนโทรล (ผู้ใช้กำหนดเองเมื่อตั้งค่าเทมเพลตสัญญา)
		fieldName		string	ชื่อคอนโทรล
		required		boolean	จำเป็นต้องกรอกหรือไม่ true-จำเป็นต้องกรอก false-ไม่จำเป็นต้องกรอก
		fieldsType		string	ประเภทของคอนโทรล: 1-ข้อความบรรทัดเดียว 15-ช่องทำเครื่องหมาย
		textField		object	คุณสมบัติของคอนโทรลข้อความ
			overflowType	int	มีผลเฉพาะกับ text 1-ปรับขนาดตัวอักษรอัตโนมัติ 2-จำกัดการป้อนข้อมูล
			minFontSize	float	มีผลเฉพาะกับ text และเฉพาะเมื่อ 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	มีผลเฉพาะกับ text ขนาดตัวอักษร 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	มีผลเฉพาะกับ text สีในรูปแบบเลขฐานสิบหก
			bold	boolean	มีผลเฉพาะกับ text ตัวอักษรเป็นตัวหนาหรือไม่ true-ตัวหนา false-ไม่ตัวหนา
			italic	boolean	มีผลเฉพาะกับ text ตัวอักษรเป็นตัวเอียงหรือไม่ true-ตัวเอียง false-ไม่เอียง
			underline	boolean	มีผลเฉพาะกับ text เท่านั้น, มีการขีดเส้นใต้ตัวอักษรหรือไม่ true-เพิ่มขีดเส้นใต้ false-ไม่เพิ่มขีดเส้นใต้
			lineThrough	boolean	มีผลเฉพาะกับ text เท่านั้น, มีการขีดฆ่าข้อความหรือไม่ true-เพิ่มขีดฆ่า false-ไม่เพิ่มขีดฆ่า
			horizontalAlignment	string	จัดกึ่งกลางแนวนอนสำหรับ text เท่านั้น LEFT-ชิดซ้าย CENTER-กึ่งกลาง RIGHT-ชิดขวา
		tickBoxField		object	คุณสมบัติของช่องทำเครื่องหมาย
			tickOptions	array	มีผลเฉพาะกับ Check เท่านั้น 1-ถูกเลือก 2-ผิด
		posX		float	พิกัดแกน X ของตำแหน่งคอนโทรล
		posY		float	ตำแหน่งคอนโทรลYพิกัดแกน Y
		pageNo		string	หมายเลขหน้าที่มีคอนโทรล
	signDateConfigs			array	ข้อมูลวันที่เซ็นชื่อ
		fieldId		string	ID ของคอนโทรล (ระบบสร้างอัตโนมัติเมื่อตั้งค่าแม่แบบสัญญา)eSignGlobal
		fieldKey		string	Key ของคอนโทรล (ผู้ใช้กำหนดเองเมื่อตั้งค่าแม่แบบสัญญา)
		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"
}