Obter detalhes do controlo de modelo de signatário

GET/esignglobal/v1/templates/signerFieldsDetail

Descrição da Interface

Consulta as informações do controlo de signatário no modelo.

Através do número do modelo de contratotemplateIdpara obter as informações do controlo de signatário definido no modelo, que pode ser usado posteriormente através daIniciar rapidamente um envelopeinterface para iniciar um envelope.

Parâmetros de Pedido

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

Exemplo de Pedido

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
signerFields				array	Informações da lista de controlos de signatários no modelo
	signConfigs			array	Informações do Controlo de Assinatura
		fieldId		string	ID do controlo (gerado automaticamente peloeSignGlobalsistema ao definir o modelo de contrato)
		fieldKey		string	Chave do controlo (definida pelo utilizador ao configurar o modelo de contrato)
		fieldType		string	Tipo de controlo: signature- Área de assinatura stamp- Área de selo approval- Controlo de aprovação
		sizeRule		string	Forma de apresentação das dimensões da área de assinatura originalSize- Aplicar o selo de acordo com as dimensões reais da assinatura/selo targetSize- Largura e altura personalizadas da área de assinatura/selo
		height		int	Altura do controlo de assinatura
		width		int	Largura do controlo de assinatura
		movable		boolean	Permitir mover a posição ao assinar false- Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura true- Permitir que o signatário ajuste a posição do seu próprio controlo de assinatura
		allowedOptions		array	Opções permitidas para aprovação pelo signatário, aplicável quando fieldType é approval. O padrão é ["approve", "decline"] approve- Aprovar decline- Rejeitar
		posX		float	Coordenada X da posição do controlo
		posY		float	Posição do controloYCoordenada Y
		pageNo		string	Número da página onde o controlo se encontra
	fillConfigs			array	Informações do controlo de assinatura
		fieldId		string	ID do controlo (gerado automaticamente peloeSignGlobalsistema ao definir o modelo de contrato)
		fieldKey		string	Chave do controlo (definida pelo utilizador ao configurar o modelo de contrato)
		fieldName		string	Nome do controlo
		required		boolean	Obrigatório? true- Obrigatório false- Não obrigatório
		fieldsType		string	Tipo de controlo: 1- Texto de linha única 15- Caixa de verificação
		textField		object	Propriedades do controlo de texto
			overflowType	int	Apenas eficaz para texto 1- Reduzir automaticamente o tamanho da fonte 2- Restringir a entrada
			minFontSize	float	Apenas eficaz para texto, apenas eficaz para 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 controlo
			fontSize	float	Apenas se aplica ao texto, 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 se aplica ao texto, cor hexadecimal
			bold	boolean	Apenas se aplica ao texto, fonte em negrito true- Negrito false- Sem negrito
			italic	boolean	Aplica-se apenas ao texto, itálico? true- Itálico false- Sem itálico
			underline	boolean	Aplica-se apenas ao texto, sublinhado? true- Sublinhado false- Sem sublinhado
			lineThrough	boolean	Aplica-se apenas ao texto, adicionar ou não um traço true-Adicionar traço false-Não adicionar traço
			horizontalAlignment	string	Aplica-se apenas ao texto, formato de alinhamento horizontal centralizado LEFT-Alinhar à esquerda CENTER-Centralizar RIGHT-Alinhar à direita
		tickBoxField		object	Atributos da caixa de verificação
			tickOptions	array	Apenas válido para Check 1-Visto 2-Cruz
		posX		float	Coordenada X da posição do controlo
		posY		float	Posição do controloYCoordenada Y
		pageNo		string	Página onde o controlo se encontra
	signDateConfigs			array	Informações da data de assinatura
		fieldId		string	ID do controlo (gerado automaticamente peloeSignGlobalsistema ao definir o modelo de contrato)
		fieldKey		string	Chave do controlo (definida pelo utilizador ao definir o modelo de contrato)
		movable		boolean	Permitir mover a posição ao assinar false- Não permitir que o signatário ajuste a posição do seu próprio controlo de assinatura true- Permitir que o signatário ajuste a posição do seu próprio controlo de assinatura
		posX		float	Coordenada X da posição do controlo
		posY		float	Posição do controloYCoordenada Y
		pageNo		string	Número da página onde o controlo se encontra
		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"
}