Lấy chi tiết điều khiển mẫu của người ký

GET/esignglobal/v1/templates/signerFieldsDetail

Mô tả giao diện

Truy vấn thông tin điều khiển người ký trong mẫu.

Thông qua mã số mẫu hợp đồngtemplateIdđể lấy thông tin điều khiển người ký đã được thiết lập trong mẫu, sau đó có thể sử dụnggiao diện khởi tạo phong bìđể khởi tạo phong bì.

Tham số yêu cầu

Tên tham số	Kiểu dữ liệu	Bắt buộc hay không	Giải thích
templateId	string	true	ID mẫu hợp đồng, có thể tra cứu trong quản lý mẫu của SaaS

Ví dụ yêu cầu

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

Tham số phản hồi

Tên tham số				Loại	Mô tả
templateId				string	ID mẫu hợp đồng
templateName				string	Tên mẫu hợp đồng
documentFields				array	Danh sách điều khiển tệp
	fieldType			string	Danh sách điều khiển chiều tệp. Dùng để thêm các điều khiển chiều tệp không liên kết với người ký trên tệp được chỉ định.
	pageNo			string	Loại điều khiển. Truyền eMeterai để biểu thị điều khiển thuế tem Indonesia.
	posX			float	Số trang mà điều khiển nằm trên đó. Điều khiển thuế tem Indonesia chỉ hỗ trợ chỉ định một trang đơn, cần truyền số trang đơn lẻ, không hỗ trợ định dạng nhiều trang liên tiếp hoặc không liên tiếp như 1-3, 1,3 v.v.
	posY			float	Độ lệch trục x, gốc tọa độ là góc dưới bên trái của trang. Phạm vi tọa độ giống với phạm vi tọa độ của các điều khiển khác.
signerFields				array	Thông tin danh sách điều khiển người ký trong mẫu
	signConfigs			array	Thông tin điều khiển ký
		fieldId		string	ID điều khiển (do hệ thống tự động tạo khi thiết lập mẫu hợp đồng)eSignGlobal
		fieldKey		string	Key điều khiển (do người dùng tùy chỉnh khi thiết lập mẫu hợp đồng)
		fieldType		string	Loại điều khiển: signature-Khu vực ký tên stamp-Khu vực đóng dấu approval-Điều khiển phê duyệt
		required		boolean	Có bắt buộc hay không, mặc định là bắt buộc true-Bắt buộc false-Không bắt buộc
		sizeRule		string	Cách hiển thị kích thước khu vực ký kết originalSize-Đặt dấu theo kích thước thực tế của chữ ký/dấu targetSize-Tùy chỉnh chiều rộng và chiều cao của khu vực ký tên/đóng dấu
		height		int	Chiều cao điều khiển ký kết
		width		int	Chiều rộng điều khiển ký kết
		movable		boolean	Cho phép di chuyển vị trí khi ký kết false-Không cho phép người ký điều chỉnh vị trí điều khiển ký kết của mình true-Cho phép người ký điều chỉnh vị trí điều khiển ký kết của mình
		allowedOptions		array	Tùy chọn cho phép người ký thực hiện phê duyệt, áp dụng khi fieldType là approval. Mặc định là ["approve", "decline"] approve-Đồng ý decline-Từ chối
		posX		float	Tọa độ X của vị trí điều khiển
		posY		float	Vị trí điều khiểnYTọa độ Y
		pageNo		string	Số trang chứa điều khiển
	fillConfigs			array	Thông tin điều khiển ký
		fieldId		string	ID điều khiển (do hệ thống tự động tạo khi thiết lập mẫu hợp đồng)eSignGlobal
		fieldKey		string	Key điều khiển (do người dùng tự định nghĩa khi thiết lập mẫu hợp đồng)
		fieldName		string	Tên điều khiển
		required		boolean	Có bắt buộc không true-Bắt buộc false-Không bắt buộc
		fieldsType		string	Loại điều khiển: 1-Văn bản một dòng 15-Hộp kiểm
		textField		object	Thuộc tính điều khiển văn bản
			overflowType	int	Chỉ áp dụng cho text 1-Tự động thu nhỏ cỡ chữ 2-Giới hạn nhập liệu
			minFontSize	float	Chỉ áp dụng cho text, chỉ áp dụng khi 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	Chiều rộng của điều khiển
			fontSize	float	Chỉ áp dụng cho text, cỡ chữ 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	Chỉ áp dụng cho text, màu sắc thập lục phân
			bold	boolean	Chỉ áp dụng cho text, có in đậm hay không true-In đậm false-Không in đậm
			italic	boolean	Chỉ áp dụng cho text, có in nghiêng hay không true-In nghiêng false-Không in nghiêng
			underline	boolean	Chỉ áp dụng cho text, có gạch chân hay không true-Thêm gạch chân false-Không thêm gạch chân
			lineThrough	boolean	Chỉ áp dụng cho text, có gạch ngang hay không true-Thêm gạch ngang false-Không thêm gạch ngang
			horizontalAlignment	string	Chỉ áp dụng cho text, căn giữa theo chiều ngang LEFT-Căn trái CENTER-Căn giữa RIGHT-Căn phải
		tickBoxField		object	Thuộc tính hộp kiểm
			tickOptions	array	Chỉ áp dụng cho Check 1-Đánh dấu tích 2-Đánh dấu chéo
		posX		float	Tọa độ ngang X của vị trí điều khiển
		posY		float	Vị trí điều khiểnYTọa độ dọc
		pageNo		string	Số trang chứa điều khiển
	signDateConfigs			array	Thông tin ngày ký
		fieldId		string	ID điều khiển (do hệ thống tự động tạo khi thiết lập mẫu hợp đồng)eSignGlobal
		fieldKey		string	Key điều khiển (do người dùng tùy chỉnh khi thiết lập mẫu hợp đồng)
		movable		boolean	Cho phép di chuyển vị trí khi ký false- Không cho phép người ký điều chỉnh vị trí điều khiển ký của mình true- Cho phép người ký điều chỉnh vị trí điều khiển ký của mình
		posX		float	Tọa độ ngang X của vị trí điều khiển
		posY		float	Vị trí điều khiểnYTọa độ dọc
		pageNo		string	Số trang chứa điều khiển
		signDateFormat		string	Định dạng ngày ký

Ví dụ phản hồi

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