Skip to content

Latest commit

 

History

History
60 lines (54 loc) · 4.83 KB

EzsignsignatureRequest.md

File metadata and controls

60 lines (54 loc) · 4.83 KB
Raw

EzmaxApi::EzsignsignatureRequest

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_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 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]
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]

Example

require 'Ezmaxapi'

instance = EzmaxApi::EzsignsignatureRequest.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_required: null,
  e_ezsignsignature_attachmentnamesource: null,
  s_ezsignsignature_attachmentdescription: Attachment,
  i_ezsignsignature_validationstep: 1,
  i_ezsignsignature_maxlength: 75,
  e_ezsignsignature_textvalidation: null,
  s_ezsignsignature_regexp: /[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/,
  e_ezsignsignature_dependencyrequirement: null
)