Получить сведения о шаблоне элемента управления подписанта

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	Ключ элемента управления (определяется пользователем вручную при настройке шаблона договора)
		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	Идентификатор элемента управления (автоматически генерируется системой при настройке шаблона договора)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	Действует только для 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	Идентификатор элемента управления (автоматически генерируется системой при настройке шаблона договора)eSignGlobal
		fieldKey		string	Ключ элемента управления (задаётся пользователем вручную при настройке шаблона договора)
		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"
}