Lấy thông tin chi tiết về điều khiển mẫu 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 số hiệu 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 này có thể thông quaKhởi tạo phong bì nhanh chónggiao diện để khởi tạo phong bì.

Tham số yêu cầu

Tên tham số	Loại	Bắt buộc hay không	Mô tả
templateId	string	true	ID mẫu hợp đồng, có thể truy vấn 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

Thông 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
signerFields				array	Thông tin danh sách các đ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)eSignGlobalhệ thống tự động tạo)
		fieldKey		string	Khóa đ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 chữ ký stamp- Khu vực con dấu approval- Điều khiển phê duyệt
		sizeRule		string	Phương thức hiển thị kích thước khu vực ký originalSize- Đóng dấu theo kích thước thực tế của chữ ký/con dấu targetSize- Tùy chỉnh chiều rộng và chiều cao của khu vực chữ ký/con dấu
		height		int	Chiều cao của điều khiển ký
		width		int	Chiều rộng của điều khiển ký
		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 họ true-Cho phép người ký điều chỉnh vị trí điều khiển ký của họ
		allowedOptions		array	Các tùy chọn cho phép người ký phê duyệt, áp dụng cho 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 độ tung
		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)eSignGlobalhệ thống tự động tạo)
		fieldKey		string	Khóa điều khiển (do người dùng tùy chỉnh 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ỉ có hiệu lực với text 1- Tự động giảm kích thước phông chữ 2- Hạn chế nhập liệu
			minFontSize	float	Chỉ có hiệu lực với text, chỉ có hiệu lực với 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 điều khiển
			fontSize	float	Chỉ có hiệu lực với text, kích thước phông 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ỉ có hiệu lực với text, màu hệ thập lục phân
			bold	boolean	Chỉ có hiệu lực với text, phông chữ có được in đậm không true- In đậm false- Không in đậm
			italic	boolean	Chỉ có hiệu lực với text, có in nghiêng không true- In nghiêng false- Không in nghiêng
			underline	boolean	Chỉ có hiệu lực với text, có thêm gạch chân cho phông chữ không true- Thêm gạch chân false- Không thêm gạch chân
			lineThrough	boolean	Chỉ có hiệu lực với text, có thêm gạch ngang hay không true-Thêm gạch ngang false-Không thêm gạch ngang
			horizontalAlignment	string	Chỉ có hiệu lực với text, định dạng 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ỉ có hiệu lực với Check 1- Đánh dấu 2- Dấu chéo
		posX		float	Tọa độ X ngang 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)eSignGlobalhệ thống tự động tạo)
		fieldKey		string	Khóa đ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 riêng họ true-Cho phép người ký điều chỉnh vị trí điều khiển ký của riêng họ
		posX		float	Tọa độ X của vị trí điều khiển
		posY		float	Vị trí điều khiểnYTọa độ tung
		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"
}