Получить подробную информацию об элементе управления шаблона подписывающего лица

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	Положение элемента управленияYY-координата
		pageNo		string	Номер страницы, на которой находится элемент управления
	fillConfigs			array	Информация об элементе управления подписью
		fieldId		string	ID элемента управления (генерируетсяeSignGlobalсистемой автоматически при настройке шаблона договора)
		fieldKey		string	Ключ элемента управления (настраивается пользователем при настройке шаблона контракта)
		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	Действует только на текст, курсив? 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	Положение элемента управленияYY-координата
		pageNo		string	Страница, на которой находится элемент управления
	signDateConfigs			array	Информация о дате подписания
		fieldId		string	ID элемента управления (генерируетсяeSignGlobalсистемой автоматически при настройке шаблона договора)
		fieldKey		string	Ключ элемента управления (определяется пользователем при настройке шаблона договора)
		movable		boolean	Разрешить перемещение местоположения при подписании false- Не разрешать подписывающему лицу регулировать положение своих элементов управления подписью true- Разрешить подписывающему лицу регулировать положение своих элементов управления подписью
		posX		float	X-координата местоположения элемента управления
		posY		float	Местоположение элемента управления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"
}