Skip to content

Latest commit

 

History

History
76 lines (70 loc) · 7.15 KB

EzsignsignatureRequestCompound.md

File metadata and controls

76 lines (70 loc) · 7.15 KB

EzmaxApi::EzsignsignatureRequestCompound

Properties

Name Type Description Notes
pki_ezsignsignature_id Integer The unique ID of the Ezsignsignature [optional]
fki_ezsignfoldersignerassociation_id Integer The unique ID of the Ezsignfoldersignerassociation
i_ezsignpage_pagenumber Integer The page number in the Ezsigndocument
i_ezsignsignature_x Integer 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 Integer 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 Integer 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 Integer 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 Integer The step when the Ezsignsigner will be invited to sign
e_ezsignsignature_type FieldEEzsignsignatureType
fki_ezsigndocument_id Integer 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 Integer The unique ID of the Ezsignfoldersignerassociation [optional]
b_ezsignsignature_handwritten Boolean Whether the Ezsignsignature must be handwritten or not when eEzsignsignatureType = Signature. [optional]
b_ezsignsignature_reason Boolean Whether the Ezsignsignature must include a reason or not when eEzsignsignatureType = Signature. [optional]
b_ezsignsignature_required Boolean Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments, Text or Textarea. [optional]
e_ezsignsignature_attachmentnamesource FieldEEzsignsignatureAttachmentnamesource [optional]
s_ezsignsignature_attachmentdescription String The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments [optional]
e_ezsignsignature_consultationtrigger FieldEEzsignsignatureConsultationtrigger [optional]
i_ezsignsignature_validationstep Integer The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments [optional]
i_ezsignsignature_maxlength Integer The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is FieldText or FieldTextarea [optional]
s_ezsignsignature_defaultvalue String The default value for the Ezsignsignature You can use the codes below and they will be replaced at signature time. Code
e_ezsignsignature_textvalidation EnumTextvalidation [optional]
s_ezsignsignature_textvalidationcustommessage String Description of validation rule. Show by signatory. [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]

Example

require 'Ezmaxapi'

instance = EzmaxApi::EzsignsignatureRequestCompound.new(
  pki_ezsignsignature_id: 49,
  fki_ezsignfoldersignerassociation_id: 20,
  i_ezsignpage_pagenumber: 1,
  i_ezsignsignature_x: 200,
  i_ezsignsignature_y: 300,
  i_ezsignsignature_width: 200,
  i_ezsignsignature_height: 200,
  i_ezsignsignature_step: 1,
  e_ezsignsignature_type: null,
  fki_ezsigndocument_id: 97,
  t_ezsignsignature_tooltip: Please sign here if you agree to the terms,
  e_ezsignsignature_tooltipposition: null,
  e_ezsignsignature_font: null,
  fki_ezsignfoldersignerassociation_id_validation: 20,
  b_ezsignsignature_handwritten: null,
  b_ezsignsignature_reason: null,
  b_ezsignsignature_required: null,
  e_ezsignsignature_attachmentnamesource: null,
  s_ezsignsignature_attachmentdescription: Attachment,
  e_ezsignsignature_consultationtrigger: null,
  i_ezsignsignature_validationstep: 1,
  i_ezsignsignature_maxlength: 75,
  s_ezsignsignature_defaultvalue: Foo,
  e_ezsignsignature_textvalidation: null,
  s_ezsignsignature_textvalidationcustommessage: Phone number,
  s_ezsignsignature_regexp: ^[0-9]{9}$,
  e_ezsignsignature_dependencyrequirement: null,
  b_ezsignsignature_customdate: null,
  a_obj_ezsignsignaturecustomdate: null,
  a_obj_ezsignelementdependency: null
)