Ottieni i dettagli del controllo del modello di firmatario

GET/esignglobal/v1/templates/signerFieldsDetail

Descrizione dell'interfaccia

Recupera le informazioni sui controlli del firmatario nel modello.

Tramite il numero del modello di contrattotemplateIdper ottenere le informazioni sui controlli del firmatario impostati nel modello, che possono essere utilizzate successivamente tramiteAvvia rapidamente la bustainterfaccia per avviare la busta.

Parametri di richiesta

Nome parametro	Tipo	Obbligatorio	Descrizione
templateId	string	true	ID modello contratto, può essere interrogato nella gestione dei modelli SaaS

Esempio di richiesta

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

Parametri di risposta

Nome parametro				Tipo	Descrizione
templateId				string	ID modello contratto
templateName				string	Nome modello contratto
signerFields				array	Informazioni sull'elenco dei controlli del firmatario nel modello
	signConfigs			array	Informazioni sul controllo di firma
		fieldId		string	ID controllo (generato automaticamente daleSignGlobalsistema durante l'impostazione del modello di contratto)
		fieldKey		string	Chiave del controllo (definita dall'utente quando imposta il modello di contratto)
		fieldType		string	Tipo di controllo: signature- Area firma stamp- Area timbro approval- Controllo di approvazione
		sizeRule		string	Modalità di visualizzazione delle dimensioni dell'area di firma originalSize- Applica il timbro in base alle dimensioni effettive della firma/timbro targetSize- Larghezza/altezza dell'area firma/timbro personalizzata
		height		int	Altezza del controllo di firma
		width		int	Larghezza del controllo di firma
		movable		boolean	Consenti lo spostamento della posizione durante la firma false- Non consentire al firmatario di regolare la posizione del proprio controllo di firma true- Consenti al firmatario di regolare la posizione del proprio controllo di firma
		allowedOptions		array	Opzioni consentite per l'approvazione del firmatario, applicabile quando fieldType è approval. Il valore predefinito è ["approve", "decline"] approve- Approva decline- Rifiuta
		posX		float	Coordinata X orizzontale della posizione del controllo
		posY		float	Posizione del controlloYCoordinata verticale
		pageNo		string	Numero di pagina in cui si trova il controllo
	fillConfigs			array	Informazioni sul controllo di firma
		fieldId		string	ID del controllo (generato automaticamente daleSignGlobalsistema durante l'impostazione del modello di contratto)
		fieldKey		string	Chiave del controllo (definita dall'utente quando imposta il modello di contratto)
		fieldName		string	Nome del controllo
		required		boolean	Obbligatorio true- Obbligatorio false- Non obbligatorio
		fieldsType		string	Tipo di controllo: 1- Testo a riga singola 15-Casella di controllo
		textField		object	Proprietà del controllo testo
			overflowType	int	Valido solo per il testo 1-Riduzione automatica della dimensione del carattere 2-Limita input
			minFontSize	float	Valido solo per il testo, valido solo per 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	Larghezza del controllo
			fontSize	float	Valido solo per il testo, dimensione del font 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	Valido solo per il testo, colore esadecimale
			bold	boolean	Valido solo per il testo, se il font è in grassetto true- Grassetto false- Non grassetto
			italic	boolean	Si applica solo al testo, se in corsivo true- Corsivo false- Non corsivo
			underline	boolean	Si applica solo al testo, se il carattere è sottolineato true- Aggiungi sottolineatura false- Non aggiungere sottolineatura
			lineThrough	boolean	Valido solo per il testo, aggiungere o meno la linea barrata true-Aggiungi linea barrata false-Non aggiungere linea barrata
			horizontalAlignment	string	Valido solo per il testo, formato di centraggio orizzontale LEFT-Allineato a sinistra CENTER-Centrato RIGHT-Allineato a destra
		tickBoxField		object	Attributi della casella di controllo
			tickOptions	array	Valido solo per Check 1-Spunta 2-Croce
		posX		float	Coordinata X orizzontale della posizione del controllo
		posY		float	Posizione del controlloYCoordinata verticale
		pageNo		string	Pagina in cui si trova il controllo
	signDateConfigs			array	Informazioni sulla data di firma
		fieldId		string	ID controllo (generato automaticamente daleSignGlobalsistema durante l'impostazione del modello di contratto)
		fieldKey		string	Chiave controllo (definita dall'utente durante l'impostazione del modello di contratto)
		movable		boolean	Consenti lo spostamento della posizione durante la firma false- Non consentire al firmatario di modificare la posizione del proprio controllo di firma true- Consenti al firmatario di modificare la posizione del proprio controllo di firma
		posX		float	Coordinata X orizzontale della posizione del controllo
		posY		float	Posizione del controlloYCoordinata verticale
		pageNo		string	Numero di pagina in cui si trova il controllo
		signDateFormat		string	Formato della data di firma

Esempio di risposta

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