Sentro ng developer

Kunin ang mga detalye ng kontrol ng template ng lumagda

GET/esignglobal/v1/templates/signerFieldsDetail

Paglalarawan ng Interface

Hanapin ang impormasyon ng kontrol ng lumagda sa template.

Sa pamamagitan ng numero ng template ng kontratatemplateIdUpang makuha ang impormasyon ng kontrol ng lumagda na nakatakda sa template, at maaaring sundan sa pamamagitan ngMabilis na magsimula ng sobreInterface upang magsimula ng sobre.

 

Mga Parameter ng Kahilingan

Pangalan ng Parameter

Uri

Kinakailangan ba?

Paglalarawan

templateId

string

true

ID ng template ng kontrata, maaaring hanapin sa pamamahala ng template ng SaaS  

Halimbawa ng Kahilingan

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

 

Mga Parameter ng Tugon

Pangalan ng Parameter

Uri

Paglalarawan

templateId

string

ID ng Template ng Kontrata

templateName

string

Pangalan ng Template ng Kontrata

signerFields

array

Listahan ng impormasyon ng mga kontrol ng lumagda sa template

 

signConfigs

array

Impormasyon ng kontrol ng paglagda

 

 

fieldId

string

ID ng kontrol (awtomatikong nabuo ngeSignGlobalsistema kapag nagtatakda ng template ng kontrata)

 

 

fieldKey

string

Susi ng Kontrol (itinatakda ng gumagamit kapag nagtatakda ng template ng kontrata)

 

 

fieldType

string

Uri ng kontrol:

signature-Lugar ng lagda

stamp-Lugar ng selyo

approval-Kontrol sa pag-apruba

 

 

sizeRule

string

Paraan ng pagpapakita ng laki ng lugar ng paglagda

originalSize-Batay sa aktwal na laki ng lagda/selyo

targetSize-Pasadyang taas at lapad ng lugar ng lagda/selyo

 

 

height

int

Taas ng kontrol sa pagpirma

 

 

width

int

Lapad ng kontrol sa pagpirma

 

 

movable

boolean

Payagan ang paglipat ng posisyon kapag pumipirma

false-Hindi pinapayagan ang lumagda na ayusin ang posisyon ng kanilang sariling kontrol sa pagpirma

true-Pinapayagan ang lumagda na ayusin ang posisyon ng kanilang sariling kontrol sa pagpirma

 

 

allowedOptions

array

Mga opsyon na pinapayagan para sa pag-apruba ng lumagda, naaangkop sa fieldType na approval. Default ay ["approve", "decline"]

approve-Sumasang-ayon

decline-Tumatanggi

 

 

posX

float

X coordinate ng posisyon ng control

 

 

posY

float

Posisyon ng controlYY coordinate

 

 

pageNo

string

Numero ng pahina kung saan naroroon ang control

 

fillConfigs

array

Impormasyon ng control sa pagpirma

 

 

fieldId

string

Control ID (awtomatikong binuo ngeSignGlobalsistema kapag nagtatakda ng template ng kontrata)

 

 

fieldKey

string

Susi ng Kontrol (itinatakda ng gumagamit kapag nagtatakda ng template ng kontrata)

 

 

fieldName

string

Pangalan ng Kontrol

 

 

required

boolean

Kung Kinakailangan

true-Kinakailangan

false-Hindi Kinakailangan

 

 

fieldsType

string

Uri ng Kontrol:

1-Isang Linya ng Teksto

15-Checkbox

 

 

textField

object

Mga Katangian ng Kontrol ng Teksto

 

 

 

overflowType

int

Para lamang sa text

1-Awtomatikong paliitin ang laki ng font

2-Limitahan ang pag-input

 

 

 

minFontSize

float

Para lamang sa text, para lamang sa 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

Lapad ng kontrol

 

 

 

fontSize

float

Para lamang sa text, laki ng 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

Para lamang sa text, hexadecimal na kulay

 

 

 

bold

boolean

Para lamang sa text, kung naka-bold ang font

true- Gawing bold

false- Huwag gawing bold

 

 

 

italic

boolean

Para lamang sa text, kung naka-italic

true- Naka-italic

false- Hindi naka-italic

 

 

 

underline

boolean

Para lamang sa text, kung may underline ang font

true- May underline

false- Walang underline

 

 

 

lineThrough

boolean

Para lamang sa text, kung magdagdag ng linya sa gitna

true-Magdagdag ng linya sa gitna

false-Huwag magdagdag ng linya sa gitna

 

 

 

horizontalAlignment

string

Para lamang sa text, format na nakasentro nang pahalang

LEFT-Nasa kaliwa

CENTER-Nasa gitna

RIGHT-Nasa kanan

 

 

tickBoxField

object

Katangian ng checkbox

 

 

 

tickOptions

array

Para lamang sa Check

1-Tsek

2-Ekis

 

 

posX

float

X coordinate ng posisyon ng control

 

 

posY

float

Posisyon ng controlYY coordinate

 

 

pageNo

string

Pahina kung saan naroroon ang control

 

signDateConfigs

array

Impormasyon sa petsa ng pagpirma

 

 

fieldId

string

Control ID (awtomatikong binuo ngeSignGlobalsistema kapag nagtatakda ng template ng kontrata)

 

 

fieldKey

string

Control Key (idine-define ng user kapag nagtatakda ng template ng kontrata)

 

 

movable

boolean

Pinapayagang ilipat ang posisyon kapag pumipirma

false-Hindi pinapayagan ang lumagda na ayusin ang posisyon ng kanyang control sa pagpirma

true-Pinapayagan ang lumagda na ayusin ang posisyon ng kanyang control sa pagpirma

 

 

posX

float

X coordinate ng lokasyon ng control

 

 

posY

float

Lokasyon ng controlYOrdinate

 

 

pageNo

string

Numero ng pahina kung saan naroroon ang control

 

 

signDateFormat

string

Format ng petsa ng pagpirma

Halimbawa ng tugon

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

 

Paglalarawan ng Interface
Mga Parameter ng Kahilingan
Halimbawa ng Kahilingan
Mga Parameter ng Tugon
Halimbawa ng tugon