Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.79 KB

EzsigntemplatedocumentRequest.md

File metadata and controls

60 lines (40 loc) · 2.79 KB

EzsigntemplatedocumentRequest

A Ezsigntemplatedocument Object

Properties

Name Type Description Notes
pkiEzsigntemplatedocumentID Integer The unique ID of the Ezsigntemplatedocument [optional]
fkiEzsigntemplateID Integer The unique ID of the Ezsigntemplate
fkiEzsigndocumentID Integer The unique ID of the Ezsigndocument [optional]
fkiEzsigntemplatesignerID Integer The unique ID of the Ezsigntemplatesigner [optional]
sEzsigntemplatedocumentName String The name of the Ezsigntemplatedocument.
eEzsigntemplatedocumentSource EEzsigntemplatedocumentSourceEnum Indicates where to look for the document binary content.
eEzsigntemplatedocumentFormat EEzsigntemplatedocumentFormatEnum Indicates the format of the template. [optional]
sEzsigntemplatedocumentBase64 byte[] The Base64 encoded binary content of the document. This field is Required when eEzsigntemplatedocumentSource = Base64. [optional]
sEzsigntemplatedocumentUrl String The url where the document content resides. This field is Required when eEzsigntemplatedocumentSource = Url. [optional]
bEzsigntemplatedocumentForcerepair Boolean Try to repair the document or flatten it if it cannot be used for electronic signature. [optional]
eEzsigntemplatedocumentForm EEzsigntemplatedocumentFormEnum If the document contains an existing PDF form this property must be set. Keep leaves the form as-is in the document. Convert removes the form and convert all the existing fields to Ezsigntemplateformfieldgroups and assign them to the specified fkiEzsigntemplatesignerID Discard removes the form from the document Flatten prints the form values in the document. [optional]
sEzsigntemplatedocumentPassword String If the source template is password protected, the password to open/modify it. [optional]

Enum: EEzsigntemplatedocumentSourceEnum

Name Value
BASE64 "Base64"
URL "Url"
EZSIGNDOCUMENT "Ezsigndocument"

Enum: EEzsigntemplatedocumentFormatEnum

Name Value
PDF "Pdf"
DOC "Doc"
DOCX "Docx"
XLS "Xls"
XLSX "Xlsx"
PPT "Ppt"
PPTX "Pptx"

Enum: EEzsigntemplatedocumentFormEnum

Name Value
KEEP "Keep"
CONVERT "Convert"
DISCARD "Discard"
FLATTEN "Flatten"