Details zum Vorlagensteuerelement des Unterzeichners abrufen

GET/esignglobal/v1/templates/signerFieldsDetail

Schnittstellenbeschreibung

Abfrage der Informationen zu den Unterschriftssteuerelementen in der Vorlage.

Über die Vertragsvorlagen-IDtemplateIdkönnen Sie die Informationen zu den in der Vorlage konfigurierten Unterschriftssteuerelementen abrufen. Anschließend können Sie überdie Schnittstelleschnell einen Briefumschlag initiieren.

Anforderungsparameter

Parametername	Typ	Pflichtfeld	Beschreibung
templateId	string	true	ID der Vertragsvorlage, kann im Template-Management von SaaS abgefragt werden

Anforderungsbeispiel

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
documentFields				array	Liste der Steuerelemente für Dateien
	fieldType			string	Liste der dateibezogenen Steuerelemente. Wird verwendet, um dateibezogene Steuerelemente ohne gebundene Unterzeichner auf einer angegebenen Datei hinzuzufügen.
	pageNo			string	Steuerelementtyp. Geben Sie eMeterai an, um das indonesische Stempelsteuerelement darzustellen.
	posX			float	Seitennummer, auf der sich das Steuerelement befindet. Das indonesische Stempelsteuerelement unterstützt nur die Angabe einer einzelnen Seite; es muss eine einzelne Seitennummer übergeben werden. Formate wie 1-3 oder 1,3 für zusammenhängende oder nicht zusammenhängende Mehrseiten sind nicht unterstützt.
	posY			float	X-Achsen-Versatz, wobei die untere linke Ecke der Seite als Koordinatenursprung dient. Der Koordinatenbereich entspricht dem anderer Steuerelemente.
signerFields				array	Informationen zur Liste der Unterzeichner-Steuerelemente in der Vorlage
	signConfigs			array	Informationen zum Unterzeichnungs-Steuerelement
		fieldId		string	Steuerelement-ID (wird vom System automatisch generiert, wenn die Vertragsvorlage eingerichtet wird)eSignGlobal
		fieldKey		string	Steuerelement-Key (vom Benutzer bei der Einrichtung der Vertragsvorlage selbst definiert)
		fieldType		string	Steuerelementtyp: signature-Signaturbereich stamp-Stempelbereich approval-Genehmigungssteuerelement
		required		boolean	Pflichtfeld, standardmäßig erforderlich true-Pflichtfeld false-Nicht Pflichtfeld
		sizeRule		string	Anzeigeart der Größe des Signaturbereichs originalSize-Stempel entsprechend der tatsächlichen Größe von Signatur/Stempel platzieren targetSize-Benutzerdefinierte Breite/Höhe des Signatur-/Stempelbereichs
		height		int	Höhe des Signatursteuerelements
		width		int	Breite des Signatursteuerelements
		movable		boolean	Position während der Signaturierung verschiebbar false-Untersucher darf die Position seines eigenen Signatursteuerelements nicht anpassen true-Untersucher darf die Position seines eigenen Signatursteuerelements anpassen
		allowedOptions		array	Optionen, die dem Untersucher zur Genehmigung erlaubt sind, gilt für fieldType=approval. Standardmäßig ["approve", "decline"] approve-Zustimmen decline-Ablehnen
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	SteuerelementpositionYY-Koordinate
		pageNo		string	Seitennummer, auf der sich das Steuerelement befindet
	fillConfigs			array	Informationen zum Unterschriftssteuerelement
		fieldId		string	Steuerelement-ID (wird vom System automatisch generiert, wenn der Vertragsvorlagen festgelegt werden)eSignGlobal
		fieldKey		string	Steuerelement-Key (wird vom Benutzer benutzerdefiniert festgelegt, wenn die Vertragsvorlage konfiguriert wird)
		fieldName		string	Steuerelementname
		required		boolean	Pflichtfeld? true-Pflichtfeld false-Nicht Pflichtfeld
		fieldsType		string	Steuerelementtyp: 1-Einzeiliger Text 15-Kontrollkästchen
		textField		object	Attribute des Textsteuerelements
			overflowType	int	Gilt nur für text 1-Automatische Schriftgrößenanpassung 2-Eingabe einschränken
			minFontSize	float	Gilt nur für text, nur bei 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, hexadezimale Farbe
			bold	boolean	Gilt nur für text, ob die Schrift fett ist true-Fett false-Nicht fett
			italic	boolean	Gilt nur für text, ob die Schrift kursiv ist true-Kursiv false-Nicht kursiv
			underline	boolean	Gilt nur für Text, ob der Text unterstrichen wird true-Unterstreichen false-Nicht unterstreichen
			lineThrough	boolean	Gilt nur für Text, ob der Text durchgestrichen wird true-Durchstreichen false-Nicht durchstreichen
			horizontalAlignment	string	Gilt nur für Text, horizontale Zentrierung LEFT-Linksbündig CENTER-Zentriert RIGHT-Rechtsbündig
		tickBoxField		object	Eigenschaften der Kontrollkästchen
			tickOptions	array	Gilt nur für Check 1-Haken 2-Kreuz
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	SteuerelementpositionYY-Koordinate
		pageNo		string	Seitennummer des Steuerelements
	signDateConfigs			array	Unterschriftsdatum-Informationen
		fieldId		string	Steuerelement-ID (wird vom System automatisch generiert, wenn der Vertragsvorlagenmodus festgelegt wird)eSignGlobal
		fieldKey		string	Steuerelement-Key (vom Benutzer benutzerdefiniert festgelegt, wenn die Vertragsvorlage konfiguriert wird)
		movable		boolean	Erlaubt Positionsänderung während der Unterschrift false- Unterschriftsberechtigte dürfen ihre Unterschriftssteuerelementposition nicht anpassen true- Unterschriftsberechtigte dürfen ihre Unterschriftssteuerelementposition anpassen
		posX		float	X-Koordinate der Steuerelementposition
		posY		float	SteuerelementpositionYY-Koordinate
		pageNo		string	Seitennummer des Steuerelements
		signDateFormat		string	Format des Unterzeichnungsdatums

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