Lấy thông tin chi tiết về mẫu

GET /esignglobal/v1/templates/templateDetail

Mô tả giao diện

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

Thông qua số hiệu mẫu hợp đồngtemplateIdđể lấy thông tin điều khiển điền được thiết lập trong mẫu, sau này có thể thông qua giao diện Điền vào mẫu để tạo tệp để điền vào mẫu.

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 danh sách mẫu của eSignGlobal

Ví dụ yêu cầu

GET  https:// … …/esignglobal/v1/templates/templateDetail?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
templateType				int	Loại Mẫu Hợp Đồng: 0-PDF, 1-WORD
createTime				string	Thời gian tạo mẫu hợp đồng (định dạng dấu thời gian Unix, đơn vị: mili giây)
updateTime				string	Thời gian cập nhật mẫu hợp đồng (định dạng dấu thời gian Unix, đơn vị: mili giây)
templateStatus				int	Trạng thái mẫu hợp đồng: 0-Chưa kích hoạt, 1-Đã kích hoạt
fields				array	Thông tin danh sách các điều khiển trong mẫu
	fieldId			string	ID điều khiển (do hệ thống eSignGlobal tự động tạo khi thiết lập mẫu hợp đồng)
	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	Điều khiển có bắt buộc không: True-Bắt buộc, false-Không bắt buộc
	fieldType			string	1-Văn bản một dòng, 2-Số, 3-Ngày, 8-Văn bản nhiều dòng, 9-Chọn nhiều, 10- Chọn một, 11- Hình ảnh, 14-Hộp thả xuống, 15-Hộp kiểm
	fieldPosition			object	Thông tin vị trí điều khiển (chỉ trả về mẫu PDF)
		posX		float	Tọa độ ngang X của vị trí điều khiển
		posY		float	Tọa độ dọc Y của vị trí điều khiển
		posNo		int	Số trang chứa điều khiển
		movable		boolean	Cho phép di chuyển vị trí khi ký, mặc định là false 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ọ
	fieldSpecialAttribute			object	Thuộc tính đặc biệt của điều khiển
		dateFormat		string	Định dạng ngày (đặc biệt của điều khiển ngày)
		imageType		string	Loại hình ảnh (đặc biệt của điều khiển hình ảnh)
		options		array	Tùy chọn (Đặc trưng của điều khiển hộp thả xuống, điều khiển radio, điều khiển đa lựa chọn)
			optionContent	string	Nội dung tùy chọn
			optionOrder	int	Thứ tự tùy chọn
			selected	boolean	Tùy chọn có được chọn mặc định không
		numberFormat		string	Định dạng số (đặc trưng của điều khiển số), định dạng như sau: 0 - số nguyên, 0.0 - giữ lại một chữ số thập phân, 0.00 - giữ lại hai chữ số thập phân
		tableContent		array	Nội dung hàng và cột của bảng (đặc trưng của điều khiển bảng động), định dạng: [row{"column1":"value1","column2":"value2"}] Giải thích bổ sung: row biểu thị hàng tương ứng của bảng động, số lượng row tùy thuộc vào mẫu Số lượng hàng được thêm vào trong điều khiển bảng động. column1 biểu thị giá trị Key của ô trong hàng hiện tại, value1 biểu thị giá trị Value của ô trong hàng hiện tại, nếu ô không được đặt giá trị cố định thì là chuỗi rỗng "", nếu không thì là giá trị cố định đã đặt. Xem giải thích chi tiết về tableContent.
		fieldMaxLength		string	Giới hạn độ dài có thể điền, đơn vị: ký tự Trung Quốc 【Lưu ý】1 ký tự Trung Quốc = 2 ký tự Anh;
	fieldSize			object	Kích thước điều khiển
		fieldWidth		float	Chiều rộng điều khiển (khoảng cách trái phải của hình chữ nhật, đơn vị là px)
		fieldHeight		float	Chiều cao điều khiển (khoảng cách trên dưới của hình chữ nhật, đơn vị là px)

Ví dụ phản hồi

{
    "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": "成功 "
}