Obter detalhes do controle de modelo do signatário

GET/esignglobal/v1/templates/signerFieldsDetail

Descrição da interface

Consulta as informações dos controles de signatário no modelo.

Através do número do modelo de contratotemplateIdpara obter as informações dos controles de signatário configurados no modelo, e posteriormente pode utilizar a interfacepara iniciar rapidamente um envelope.

Parâmetros de solicitação

Nome do parâmetro	Tipo	Obrigatório	Descrição
templateId	string	true	ID do modelo de contrato, que pode ser consultado na gestão de modelos do SaaS

Exemplo de solicitação

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

Parâmetros de resposta

Nome do parâmetro				Tipo	Descrição
templateId				string	ID do modelo de contrato
templateName				string	Nome do modelo de contrato
documentFields				array	Lista de controles de arquivo
	fieldType			string	Lista de controles de dimensão do arquivo. Usada para adicionar controles de dimensão do arquivo não vinculados a signatários em um arquivo especificado.
	pageNo			string	Tipo de controle. Envie eMeterai para indicar o controle de imposto de carimbos da Indonésia.
	posX			float	Número da página onde o controle está localizado. O controle de imposto de carimbos da Indonésia suporta apenas a especificação de uma única página; deve ser fornecido um único número de página, não sendo suportados formatos de múltiplas páginas contínuas ou não contínuas como 1-3 ou 1,3.
	posY			float	Deslocamento no eixo x, com a origem das coordenadas no canto inferior esquerdo da página. O intervalo de coordenadas é consistente com o intervalo de coordenadas de outros controles.
signerFields				array	Informações sobre a lista de controles de signatário no modelo
	signConfigs			array	Informações do controle de assinatura
		fieldId		string	ID do controle (gerado automaticamente pelo sistema ao configurar o modelo de contrato)eSignGlobal
		fieldKey		string	Chave do controle (definida pelo usuário ao configurar o modelo de contrato)
		fieldType		string	Tipo de controle: signature-Área de assinatura stamp-Área do carimbo approval-Controle de aprovação
		required		boolean	Se é obrigatório, padrão é obrigatório true-Obrigatório false-Não obrigatório
		sizeRule		string	Modo de exibição das dimensões da área de assinatura originalSize-Posicionar o carimbo com base no tamanho real da assinatura/carimbo targetSize-Largura e altura personalizadas para a área de assinatura/carimbo
		height		int	Altura do controle de assinatura
		width		int	Largura do controle de assinatura
		movable		boolean	Permitir mover a posição durante a assinatura false-Não permitir que o signatário ajuste a posição do seu próprio controle de assinatura true-Permitir que o signatário ajuste a posição do seu próprio controle de assinatura
		allowedOptions		array	Opções que permitem ao signatário aprovar, aplicável quando fieldType for approval. Padrão: ["approve", "decline"] approve-Concordo decline-Recuso
		posX		float	Coordenada X da posição do controle
		posY		float	Posição do controleYCoordenada Y
		pageNo		string	Número da página onde o controle está localizado
	fillConfigs			array	Informações do controle de assinatura
		fieldId		string	ID do controle (gerado automaticamente pelo sistema ao configurar o modelo de contrato)eSignGlobal
		fieldKey		string	Chave do controle (definida pelo usuário ao configurar o modelo de contrato)
		fieldName		string	Nome do controle
		required		boolean	É obrigatório? true-Obrigatório false-Não obrigatório
		fieldsType		string	Tipo de controle: 1-Texto de uma linha 15-Caixa de seleção
		textField		object	Propriedades do controle de texto
			overflowType	int	Apenas válido para text 1-Reduzir automaticamente o tamanho da fonte 2-Limitar entrada
			minFontSize	float	Apenas válido para text, apenas válido quando 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	Largura do controle
			fontSize	float	Apenas válido para text, tamanho da fonte 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	Apenas válido para text, cor em hexadecimal
			bold	boolean	Apenas válido para text, se a fonte deve ser negrito true-Negrito false-Sem negrito
			italic	boolean	Apenas válido para text, se a fonte deve ser itálico true-Itálico false-Não itálico
			underline	boolean	Apenas afeta o texto, se adiciona sublinhado à fonte true-Adicionar sublinhado false-Não adicionar sublinhado
			lineThrough	boolean	Apenas afeta o texto, se adiciona risco ao texto true-Adicionar risco ao texto false-Não adicionar risco ao texto
			horizontalAlignment	string	Apenas afeta o texto, formatação de centralização horizontal LEFT-Alinhar à esquerda CENTER-Centralizar RIGHT-Alinhar à direita
		tickBoxField		object	Propriedades da caixa de seleção
			tickOptions	array	Apenas afeta a verificação (Check) 1-Marcação 2-X
		posX		float	Coordenada X da posição do controle
		posY		float	Posição do controleYCoordenada Y
		pageNo		string	Número da página onde o controle está localizado
	signDateConfigs			array	Informações sobre a data de assinatura
		fieldId		string	ID do controle (gerado automaticamente pelo sistema ao configurar o modelo de contrato)eSignGlobal
		fieldKey		string	Chave do controle (definida pelo usuário ao configurar o modelo de contrato)
		movable		boolean	Permitir movimentação da posição durante a assinatura false- Não permitir que o signatário ajuste a posição dos seus controles de assinatura true- Permitir que o signatário ajuste a posição dos seus controles de assinatura
		posX		float	Coordenada X da posição do controle
		posY		float	Posição do controleYCoordenada Y
		pageNo		string	Número da página onde o controle está localizado
		signDateFormat		string	Formato da data de assinatura

Exemplo de resposta

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