Skip to content

Latest commit

 

History

History
39 lines (34 loc) · 4.71 KB

EzsignsignatureRequestCompound.md

File metadata and controls

39 lines (34 loc) · 4.71 KB

EzmaxApi::Object::EzsignsignatureRequestCompound

Load the model package

use EzmaxApi::Object::EzsignsignatureRequestCompound;

Properties

Name Type Description Notes
pki_ezsignsignature_id int The unique ID of the Ezsignsignature [optional]
fki_ezsignfoldersignerassociation_id int The unique ID of the Ezsignfoldersignerassociation
i_ezsignpage_pagenumber int The page number in the Ezsigndocument
i_ezsignsignature_x int The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use "200" for the X coordinate.
i_ezsignsignature_y int The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use "300" for the Y coordinate.
i_ezsignsignature_width int The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use "200" for the iEzsignsignatureWidth. [optional]
i_ezsignsignature_height int The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use "200" for the iEzsignsignatureHeight. [optional]
i_ezsignsignature_step int The step when the Ezsignsigner will be invited to sign
e_ezsignsignature_type FieldEEzsignsignatureType
fki_ezsigndocument_id int The unique ID of the Ezsigndocument
t_ezsignsignature_tooltip string A tooltip that will be presented to Ezsignsigner about the Ezsignsignature [optional]
e_ezsignsignature_tooltipposition FieldEEzsignsignatureTooltipposition [optional]
e_ezsignsignature_font FieldEEzsignsignatureFont [optional]
fki_ezsignfoldersignerassociation_id_validation int The unique ID of the Ezsignfoldersignerassociation [optional]
b_ezsignsignature_required boolean Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments. [optional]
e_ezsignsignature_attachmentnamesource FieldEEzsignsignatureAttachmentnamesource [optional]
s_ezsignsignature_attachmentdescription string The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments [optional]
i_ezsignsignature_validationstep int The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments [optional]
i_ezsignsignature_maxlength int The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is FieldText or FieldTextarea [optional]
e_ezsignsignature_textvalidation EnumTextvalidation [optional]
s_ezsignsignature_regexp string A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is FieldText or FieldTextarea and eEzsignsignatureTextvalidation is Custom [optional]
e_ezsignsignature_dependencyrequirement FieldEEzsignsignatureDependencyrequirement [optional]
b_ezsignsignature_customdate boolean Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is Name or Handwritten) [optional]
a_obj_ezsignsignaturecustomdate ARRAY[EzsignsignaturecustomdateRequestCompound] An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all. [optional]
a_obj_ezsignelementdependency ARRAY[EzsignelementdependencyRequestCompound] [optional]

[Back to Model list] [Back to API list] [Back to README]