Details zur Vorlage für Unterzeichner-Steuerelemente abrufen

GET/esignglobal/v1/templates/signerFieldsDetail

Schnittstellenbeschreibung

Abfrage der Informationen zu den Unterzeichner-Steuerelementen in der Vorlage.

Über die VertragsnummertemplateIdum die in der Vorlage eingestellten Informationen zu den Unterzeichner-Steuerelementen abzurufen, die später überSchnelles Starten von UmschlägenSchnittstelle zum Starten von Umschlägen.

Anfrageparameter

Parametername	Typ	Ist das Ausfüllen erforderlich?	Beschreibung
templateId	string	true	Vertragsvorlagen-ID, kann in der SaaS-Vorlagenverwaltung abgefragt werden

Beispielanfrage

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

Antwortparameter

Parametername				Typ	Beschreibung
templateId				string	Vertragsvorlagen-ID
templateName				string	Name der Vertragsvorlage
signerFields				array	Liste der Informationen zu den Unterzeichner-Steuerelementen in der Vorlage
	signConfigs			array	Informationen zum Signatur-Steuerelement
		fieldId		string	Steuerelement-ID (wird beim Einrichten der Vertragsvorlage vomeSignGlobalSystem automatisch generiert)
		fieldKey		string	Steuerelement-Key (wird bei der Festlegung der Vertragsvorlage vom Benutzer definiert)
		fieldType		string	Steuerelementtyp: signature- Unterschriftsbereich stamp- Stempelbereich approval- Genehmigungs-Steuerelement
		sizeRule		string	Anzeigemodus für die Größe des Signaturbereichs originalSize- Stempelung basierend auf der tatsächlichen Größe der Unterschrift/des Stempels targetSize- Benutzerdefinierte Breite und Höhe des Unterschrifts-/Stempelbereichs
		height		int	Höhe des Signaturfelds
		width		int	Breite des Signaturfelds
		movable		boolean	Bewegung der Position beim Signieren zulassen false- Dem Unterzeichner ist es nicht erlaubt, die Position seines eigenen Signaturfelds anzupassen true- Dem Unterzeichner ist es erlaubt, die Position seines eigenen Signaturfelds anzupassen
		allowedOptions		array	Optionen, die der Unterzeichner genehmigen kann, gelten für fieldType als approval. Standardmäßig ist dies ["approve", "decline"] approve- Zustimmen decline- Ablehnen
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	SteuerelementpositionYY-Koordinate
		pageNo		string	Seitenzahl des Steuerelements
	fillConfigs			array	Informationen zum Signatursteuerelement
		fieldId		string	Steuerelement-ID (wird bei der Einrichtung der Vertragsvorlage voneSignGlobalSystem automatisch generiert)
		fieldKey		string	Steuerelement-Key (wird bei der Einrichtung der Vertragsvorlage vom Benutzer definiert)
		fieldName		string	Name des Steuerelements
		required		boolean	Ist erforderlich true- Erforderlich false- Nicht erforderlich
		fieldsType		string	Steuerelementtyp: 1- Einzeiliger Text 15- Kontrollkästchen
		textField		object	Textsteuerelement-Eigenschaften
			overflowType	int	Wirkt sich nur auf Text aus 1- Automatische Schriftgrößenreduzierung 2- Eingabe beschränken
			minFontSize	float	Wirkt sich nur auf Text aus, nur auf 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	Steuerelementbreite
			fontSize	float	Gilt nur für Text, Schriftgröße 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	Gilt nur für Text, Hexadezimalfarbe
			bold	boolean	Gilt nur für Text, ob die Schrift fett gedruckt ist true-Fett false-Nicht fett
			italic	boolean	Gilt nur für Text, ob kursiv true-Kursiv false-Nicht kursiv
			underline	boolean	Gilt nur für Text, ob die Schriftart unterstrichen ist true-Unterstreichen false-Nicht unterstreichen
			lineThrough	boolean	Wirkt sich nur auf Text aus, soll eine Durchstreichung hinzugefügt werden? true-Durchstreichung hinzufügen false-Keine Durchstreichung hinzufügen
			horizontalAlignment	string	Wirkt sich nur auf Text aus, horizontale Zentrierung LEFT-Links CENTER-Zentriert RIGHT-Rechts
		tickBoxField		object	Kontrollkästchen-Attribute
			tickOptions	array	Gilt nur für Check 1-Haken 2-Kreuz
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	SteuerelementpositionYY-Koordinate
		pageNo		string	Seitenzahl, auf der sich das Steuerelement befindet
	signDateConfigs			array	Informationen zum Unterzeichnungsdatum
		fieldId		string	Steuerelement-ID (wird bei der Einrichtung der Vertragsvorlage voneSignGlobalSystem automatisch generiert)
		fieldKey		string	Steuerelement-Key (wird bei der Einrichtung der Vertragsvorlage vom Benutzer definiert)
		movable		boolean	Bewegung der Position bei der Unterzeichnung zulässig false- Dem Unterzeichner ist es nicht erlaubt, die Position seiner eigenen Unterzeichnungs-Steuerelemente anzupassen true- Dem Unterzeichner ist es erlaubt, die Position seiner eigenen Unterzeichnungs-Steuerelemente anzupassen
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	SteuerelementpositionYY-Koordinate
		pageNo		string	Seitenzahl des Steuerelements
		signDateFormat		string	Datumsformat der Unterschrift

Beispielantwort

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