EzmaxApi::ObjectEzsigndocumentApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
ezsigndocument_apply_ezsigntemplate_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate	Apply an Ezsigntemplate to the Ezsigndocument.
ezsigndocument_apply_ezsigntemplate_v2	POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate	Apply an Ezsigntemplate to the Ezsigndocument.
ezsigndocument_apply_ezsigntemplateglobal_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplateglobal	Apply an Ezsigntemplateglobal to the Ezsigndocument.
ezsigndocument_create_ezsignelements_positioned_by_word_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord	Create multiple Ezsignsignatures/Ezsignformfieldgroups
ezsigndocument_create_object_v1	POST /1/object/ezsigndocument	Create a new Ezsigndocument
ezsigndocument_create_object_v2	POST /2/object/ezsigndocument	Create a new Ezsigndocument
ezsigndocument_decline_to_sign_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign	Decline to sign
ezsigndocument_delete_object_v1	DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID}	Delete an existing Ezsigndocument
ezsigndocument_edit_ezsignformfieldgroups_v1	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups	Edit multiple Ezsignformfieldgroups
ezsigndocument_edit_ezsignsignatures_v1	PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures	Edit multiple Ezsignsignatures
ezsigndocument_end_prematurely_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely	End prematurely
ezsigndocument_flatten_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten	Flatten
ezsigndocument_get_actionable_elements_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements	Retrieve actionable elements for the Ezsigndocument
ezsigndocument_get_attachments_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments	Retrieve Ezsigndocument's Attachments
ezsigndocument_get_completed_elements_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements	Retrieve completed elements for the Ezsigndocument
ezsigndocument_get_download_url_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType}	Retrieve a URL to download documents.
ezsigndocument_get_ezsignannotations_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations	Retrieve an existing Ezsigndocument's Ezsignannotations
ezsigndocument_get_ezsigndiscussions_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions	Retrieve an existing Ezsigndocument's Ezsigndiscussions
ezsigndocument_get_ezsignformfieldgroups_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups	Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
ezsigndocument_get_ezsignpages_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages	Retrieve an existing Ezsigndocument's Ezsignpages
ezsigndocument_get_ezsignsignatures_automatic_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic	Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
ezsigndocument_get_ezsignsignatures_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures	Retrieve an existing Ezsigndocument's Ezsignsignatures
ezsigndocument_get_form_data_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData	Retrieve an existing Ezsigndocument's Form Data
ezsigndocument_get_object_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}	Retrieve an existing Ezsigndocument
ezsigndocument_get_object_v2	GET /2/object/ezsigndocument/{pkiEzsigndocumentID}	Retrieve an existing Ezsigndocument
ezsigndocument_get_temporary_proof_v1	GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof	Retrieve the temporary proof
ezsigndocument_get_words_positions_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions	Retrieve positions X,Y of given words from a Ezsigndocument
ezsigndocument_patch_object_v1	PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID}	Patch an existing Ezsigndocument
ezsigndocument_submit_ezsignform_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform	Submit the Ezsignform
ezsigndocument_unsend_v1	POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend	Unsend the Ezsigndocument

ezsigndocument_apply_ezsigntemplate_v1

ezsigndocument_apply_ezsigntemplate_v1(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request)

Apply an Ezsigntemplate to the Ezsigndocument.

This function is deprecated. Please use applyEzsigntemplate instead which is doing the same thing but with a capital "E" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_apply_ezsigntemplate_v1_request = EzmaxApi::EzsigndocumentApplyEzsigntemplateV1Request.new({fki_ezsigntemplate_id: 36, a_s_ezsigntemplatesigner: ['John'], a_pki_ezsignfoldersignerassociation_id: [20]}) # EzsigndocumentApplyEzsigntemplateV1Request | 

begin
  # Apply an Ezsigntemplate to the Ezsigndocument.
  result = api_instance.ezsigndocument_apply_ezsigntemplate_v1(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_apply_ezsigntemplate_v1: #{e}"
end

Using the ezsigndocument_apply_ezsigntemplate_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_apply_ezsigntemplate_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request)

begin
  # Apply an Ezsigntemplate to the Ezsigndocument.
  data, status_code, headers = api_instance.ezsigndocument_apply_ezsigntemplate_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentApplyEzsigntemplateV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_apply_ezsigntemplate_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_apply_ezsigntemplate_v1_request	EzsigndocumentApplyEzsigntemplateV1Request

Return type

EzsigndocumentApplyEzsigntemplateV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_apply_ezsigntemplate_v2

ezsigndocument_apply_ezsigntemplate_v2(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request)

Apply an Ezsigntemplate to the Ezsigndocument.

This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_apply_ezsigntemplate_v2_request = EzmaxApi::EzsigndocumentApplyEzsigntemplateV2Request.new({fki_ezsigntemplate_id: 36, a_s_ezsigntemplatesigner: ['John'], a_pki_ezsignfoldersignerassociation_id: [20]}) # EzsigndocumentApplyEzsigntemplateV2Request | 

begin
  # Apply an Ezsigntemplate to the Ezsigndocument.
  result = api_instance.ezsigndocument_apply_ezsigntemplate_v2(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_apply_ezsigntemplate_v2: #{e}"
end

Using the ezsigndocument_apply_ezsigntemplate_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_apply_ezsigntemplate_v2_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request)

begin
  # Apply an Ezsigntemplate to the Ezsigndocument.
  data, status_code, headers = api_instance.ezsigndocument_apply_ezsigntemplate_v2_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentApplyEzsigntemplateV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_apply_ezsigntemplate_v2_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_apply_ezsigntemplate_v2_request	EzsigndocumentApplyEzsigntemplateV2Request

Return type

EzsigndocumentApplyEzsigntemplateV2Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_apply_ezsigntemplateglobal_v1

ezsigndocument_apply_ezsigntemplateglobal_v1(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplateglobal_v1_request)

Apply an Ezsigntemplateglobal to the Ezsigndocument.

This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_apply_ezsigntemplateglobal_v1_request = EzmaxApi::EzsigndocumentApplyEzsigntemplateglobalV1Request.new({fki_ezsigntemplateglobal_id: 36, a_s_ezsigntemplateglobalsigner: ['John'], a_pki_ezsignfoldersignerassociation_id: [20]}) # EzsigndocumentApplyEzsigntemplateglobalV1Request | 

begin
  # Apply an Ezsigntemplateglobal to the Ezsigndocument.
  result = api_instance.ezsigndocument_apply_ezsigntemplateglobal_v1(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplateglobal_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_apply_ezsigntemplateglobal_v1: #{e}"
end

Using the ezsigndocument_apply_ezsigntemplateglobal_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_apply_ezsigntemplateglobal_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplateglobal_v1_request)

begin
  # Apply an Ezsigntemplateglobal to the Ezsigndocument.
  data, status_code, headers = api_instance.ezsigndocument_apply_ezsigntemplateglobal_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplateglobal_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentApplyEzsigntemplateglobalV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_apply_ezsigntemplateglobal_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_apply_ezsigntemplateglobal_v1_request	EzsigndocumentApplyEzsigntemplateglobalV1Request

Return type

EzsigndocumentApplyEzsigntemplateglobalV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_create_ezsignelements_positioned_by_word_v1

ezsigndocument_create_ezsignelements_positioned_by_word_v1(pki_ezsigndocument_id, ezsigndocument_create_ezsignelements_positioned_by_word_v1_request)

Create multiple Ezsignsignatures/Ezsignformfieldgroups

Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_create_ezsignelements_positioned_by_word_v1_request = EzmaxApi::EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.new({a_obj_ezsignformfieldgroup: [EzmaxApi::CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.new({fki_ezsigndocument_id: 97, e_ezsignformfieldgroup_type: EzmaxApi::FieldEEzsignformfieldgroupType::TEXT, s_ezsignformfieldgroup_label: 'Allergies', i_ezsignformfieldgroup_step: 1, i_ezsignformfieldgroup_filledmin: 1, i_ezsignformfieldgroup_filledmax: 2, b_ezsignformfieldgroup_readonly: false, a_obj_ezsignformfieldgroupsigner: [EzmaxApi::EzsignformfieldgroupsignerRequestCompound.new({fki_ezsignfoldersignerassociation_id: 20})], a_obj_ezsignformfield: [EzmaxApi::EzsignformfieldRequestCompound.new({i_ezsignpage_pagenumber: 1, s_ezsignformfield_label: 'Peanuts', i_ezsignformfield_x: 200, i_ezsignformfield_y: 300, i_ezsignformfield_width: 102, i_ezsignformfield_height: 22})], obj_createezsignelementspositionedbyword: EzmaxApi::CustomCreateEzsignelementsPositionedByWordRequest.new({s_createezsignelementspositionedbyword_pattern: 's_createezsignelementspositionedbyword_pattern_example', i_createezsignelementspositionedbyword_offsetx: 37, i_createezsignelementspositionedbyword_offsety: 37, e_createezsignelementspositionedbyword_occurance: 'All'})})], a_obj_ezsignsignature: [EzmaxApi::CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.new({fki_ezsignfoldersignerassociation_id: 20, i_ezsignpage_pagenumber: 1, i_ezsignsignature_x: 200, i_ezsignsignature_y: 300, i_ezsignsignature_step: 1, e_ezsignsignature_type: EzmaxApi::FieldEEzsignsignatureType::ACKNOWLEDGEMENT, fki_ezsigndocument_id: 97, obj_createezsignelementspositionedbyword: EzmaxApi::CustomCreateEzsignelementsPositionedByWordRequest.new({s_createezsignelementspositionedbyword_pattern: 's_createezsignelementspositionedbyword_pattern_example', i_createezsignelementspositionedbyword_offsetx: 37, i_createezsignelementspositionedbyword_offsety: 37, e_createezsignelementspositionedbyword_occurance: 'All'})})]}) # EzsigndocumentCreateEzsignelementsPositionedByWordV1Request | 

begin
  # Create multiple Ezsignsignatures/Ezsignformfieldgroups
  result = api_instance.ezsigndocument_create_ezsignelements_positioned_by_word_v1(pki_ezsigndocument_id, ezsigndocument_create_ezsignelements_positioned_by_word_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_create_ezsignelements_positioned_by_word_v1: #{e}"
end

Using the ezsigndocument_create_ezsignelements_positioned_by_word_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_create_ezsignelements_positioned_by_word_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_create_ezsignelements_positioned_by_word_v1_request)

begin
  # Create multiple Ezsignsignatures/Ezsignformfieldgroups
  data, status_code, headers = api_instance.ezsigndocument_create_ezsignelements_positioned_by_word_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_create_ezsignelements_positioned_by_word_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentCreateEzsignelementsPositionedByWordV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_create_ezsignelements_positioned_by_word_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_create_ezsignelements_positioned_by_word_v1_request	EzsigndocumentCreateEzsignelementsPositionedByWordV1Request

Return type

EzsigndocumentCreateEzsignelementsPositionedByWordV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_create_object_v1

ezsigndocument_create_object_v1(ezsigndocument_create_object_v1_request)

Create a new Ezsigndocument

The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
ezsigndocument_create_object_v1_request = [EzmaxApi::EzsigndocumentCreateObjectV1Request.new] # Array<EzsigndocumentCreateObjectV1Request> | 

begin
  # Create a new Ezsigndocument
  result = api_instance.ezsigndocument_create_object_v1(ezsigndocument_create_object_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_create_object_v1: #{e}"
end

Using the ezsigndocument_create_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_create_object_v1_with_http_info(ezsigndocument_create_object_v1_request)

begin
  # Create a new Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_create_object_v1_with_http_info(ezsigndocument_create_object_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentCreateObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_create_object_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
ezsigndocument_create_object_v1_request	Array<EzsigndocumentCreateObjectV1Request>

Return type

EzsigndocumentCreateObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_create_object_v2

ezsigndocument_create_object_v2(ezsigndocument_create_object_v2_request)

Create a new Ezsigndocument

The endpoint allows to create one or many elements at once.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
ezsigndocument_create_object_v2_request = EzmaxApi::EzsigndocumentCreateObjectV2Request.new({a_obj_ezsigndocument: [EzmaxApi::EzsigndocumentRequestCompound.new({fki_ezsignfolder_id: 33, fki_language_id: 2, e_ezsigndocument_source: 'Base64', dt_ezsigndocument_duedate: '2020-12-31 23:59:59', s_ezsigndocument_name: 'Contract #123'})]}) # EzsigndocumentCreateObjectV2Request | 

begin
  # Create a new Ezsigndocument
  result = api_instance.ezsigndocument_create_object_v2(ezsigndocument_create_object_v2_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_create_object_v2: #{e}"
end

Using the ezsigndocument_create_object_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_create_object_v2_with_http_info(ezsigndocument_create_object_v2_request)

begin
  # Create a new Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_create_object_v2_with_http_info(ezsigndocument_create_object_v2_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentCreateObjectV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_create_object_v2_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
ezsigndocument_create_object_v2_request	EzsigndocumentCreateObjectV2Request

Return type

EzsigndocumentCreateObjectV2Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_decline_to_sign_v1

ezsigndocument_decline_to_sign_v1(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request)

Decline to sign

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_decline_to_sign_v1_request = EzmaxApi::EzsigndocumentDeclineToSignV1Request.new({s_reason: 'Wrong document'}) # EzsigndocumentDeclineToSignV1Request | 

begin
  # Decline to sign
  result = api_instance.ezsigndocument_decline_to_sign_v1(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_decline_to_sign_v1: #{e}"
end

Using the ezsigndocument_decline_to_sign_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_decline_to_sign_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request)

begin
  # Decline to sign
  data, status_code, headers = api_instance.ezsigndocument_decline_to_sign_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentDeclineToSignV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_decline_to_sign_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_decline_to_sign_v1_request	EzsigndocumentDeclineToSignV1Request

Return type

EzsigndocumentDeclineToSignV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_delete_object_v1

ezsigndocument_delete_object_v1(pki_ezsigndocument_id)

Delete an existing Ezsigndocument

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Delete an existing Ezsigndocument
  result = api_instance.ezsigndocument_delete_object_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_delete_object_v1: #{e}"
end

Using the ezsigndocument_delete_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_delete_object_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Delete an existing Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_delete_object_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentDeleteObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_delete_object_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_edit_ezsignformfieldgroups_v1

ezsigndocument_edit_ezsignformfieldgroups_v1(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request)

Edit multiple Ezsignformfieldgroups

Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_edit_ezsignformfieldgroups_v1_request = EzmaxApi::EzsigndocumentEditEzsignformfieldgroupsV1Request.new({a_obj_ezsignformfieldgroup: [EzmaxApi::EzsignformfieldgroupRequestCompound.new({fki_ezsigndocument_id: 97, e_ezsignformfieldgroup_type: EzmaxApi::FieldEEzsignformfieldgroupType::TEXT, s_ezsignformfieldgroup_label: 'Allergies', i_ezsignformfieldgroup_step: 1, i_ezsignformfieldgroup_filledmin: 1, i_ezsignformfieldgroup_filledmax: 2, b_ezsignformfieldgroup_readonly: false, a_obj_ezsignformfieldgroupsigner: [EzmaxApi::EzsignformfieldgroupsignerRequestCompound.new({fki_ezsignfoldersignerassociation_id: 20})], a_obj_ezsignformfield: [EzmaxApi::EzsignformfieldRequestCompound.new({i_ezsignpage_pagenumber: 1, s_ezsignformfield_label: 'Peanuts', i_ezsignformfield_x: 200, i_ezsignformfield_y: 300, i_ezsignformfield_width: 102, i_ezsignformfield_height: 22})]})]}) # EzsigndocumentEditEzsignformfieldgroupsV1Request | 

begin
  # Edit multiple Ezsignformfieldgroups
  result = api_instance.ezsigndocument_edit_ezsignformfieldgroups_v1(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_edit_ezsignformfieldgroups_v1: #{e}"
end

Using the ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request)

begin
  # Edit multiple Ezsignformfieldgroups
  data, status_code, headers = api_instance.ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentEditEzsignformfieldgroupsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_edit_ezsignformfieldgroups_v1_request	EzsigndocumentEditEzsignformfieldgroupsV1Request

Return type

EzsigndocumentEditEzsignformfieldgroupsV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_edit_ezsignsignatures_v1

ezsigndocument_edit_ezsignsignatures_v1(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request)

Edit multiple Ezsignsignatures

Using this endpoint, you can edit multiple Ezsignsignatures at the same time.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_edit_ezsignsignatures_v1_request = EzmaxApi::EzsigndocumentEditEzsignsignaturesV1Request.new({a_obj_ezsignsignature: [EzmaxApi::EzsignsignatureRequestCompound.new({fki_ezsignfoldersignerassociation_id: 20, i_ezsignpage_pagenumber: 1, i_ezsignsignature_x: 200, i_ezsignsignature_y: 300, i_ezsignsignature_step: 1, e_ezsignsignature_type: EzmaxApi::FieldEEzsignsignatureType::ACKNOWLEDGEMENT, fki_ezsigndocument_id: 97})]}) # EzsigndocumentEditEzsignsignaturesV1Request | 

begin
  # Edit multiple Ezsignsignatures
  result = api_instance.ezsigndocument_edit_ezsignsignatures_v1(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_edit_ezsignsignatures_v1: #{e}"
end

Using the ezsigndocument_edit_ezsignsignatures_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_edit_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request)

begin
  # Edit multiple Ezsignsignatures
  data, status_code, headers = api_instance.ezsigndocument_edit_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentEditEzsignsignaturesV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_edit_ezsignsignatures_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_edit_ezsignsignatures_v1_request	EzsigndocumentEditEzsignsignaturesV1Request

Return type

EzsigndocumentEditEzsignsignaturesV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_end_prematurely_v1

ezsigndocument_end_prematurely_v1(pki_ezsigndocument_id, body)

End prematurely

End prematurely an Ezsigndocument when some signatures are still required

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
body = { ... } # Object | 

begin
  # End prematurely
  result = api_instance.ezsigndocument_end_prematurely_v1(pki_ezsigndocument_id, body)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_end_prematurely_v1: #{e}"
end

Using the ezsigndocument_end_prematurely_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_end_prematurely_v1_with_http_info(pki_ezsigndocument_id, body)

begin
  # End prematurely
  data, status_code, headers = api_instance.ezsigndocument_end_prematurely_v1_with_http_info(pki_ezsigndocument_id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentEndPrematurelyV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_end_prematurely_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
body	Object

Return type

EzsigndocumentEndPrematurelyV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_flatten_v1

ezsigndocument_flatten_v1(pki_ezsigndocument_id, body)

Flatten

Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
body = { ... } # Object | 

begin
  # Flatten
  result = api_instance.ezsigndocument_flatten_v1(pki_ezsigndocument_id, body)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_flatten_v1: #{e}"
end

Using the ezsigndocument_flatten_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_flatten_v1_with_http_info(pki_ezsigndocument_id, body)

begin
  # Flatten
  data, status_code, headers = api_instance.ezsigndocument_flatten_v1_with_http_info(pki_ezsigndocument_id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentFlattenV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_flatten_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
body	Object

Return type

EzsigndocumentFlattenV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_get_actionable_elements_v1

ezsigndocument_get_actionable_elements_v1(pki_ezsigndocument_id)

Retrieve actionable elements for the Ezsigndocument

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve actionable elements for the Ezsigndocument
  result = api_instance.ezsigndocument_get_actionable_elements_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_actionable_elements_v1: #{e}"
end

Using the ezsigndocument_get_actionable_elements_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_actionable_elements_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve actionable elements for the Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_get_actionable_elements_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetActionableElementsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_actionable_elements_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetActionableElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_attachments_v1

ezsigndocument_get_attachments_v1(pki_ezsigndocument_id)

Retrieve Ezsigndocument's Attachments

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve Ezsigndocument's Attachments
  result = api_instance.ezsigndocument_get_attachments_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_attachments_v1: #{e}"
end

Using the ezsigndocument_get_attachments_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_attachments_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve Ezsigndocument's Attachments
  data, status_code, headers = api_instance.ezsigndocument_get_attachments_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetAttachmentsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_attachments_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetAttachmentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_completed_elements_v1

ezsigndocument_get_completed_elements_v1(pki_ezsigndocument_id)

Retrieve completed elements for the Ezsigndocument

Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve completed elements for the Ezsigndocument
  result = api_instance.ezsigndocument_get_completed_elements_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_completed_elements_v1: #{e}"
end

Using the ezsigndocument_get_completed_elements_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_completed_elements_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve completed elements for the Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_get_completed_elements_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetCompletedElementsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_completed_elements_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetCompletedElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_download_url_v1

ezsigndocument_get_download_url_v1(pki_ezsigndocument_id, e_document_type)

Retrieve a URL to download documents.

This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
e_document_type = 'Initial' # String | The type of document to retrieve.  1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied in current document if eEzsignfolderCompletion is PerEzsigndocument.<br>     Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. 

begin
  # Retrieve a URL to download documents.
  result = api_instance.ezsigndocument_get_download_url_v1(pki_ezsigndocument_id, e_document_type)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_download_url_v1: #{e}"
end

Using the ezsigndocument_get_download_url_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_download_url_v1_with_http_info(pki_ezsigndocument_id, e_document_type)

begin
  # Retrieve a URL to download documents.
  data, status_code, headers = api_instance.ezsigndocument_get_download_url_v1_with_http_info(pki_ezsigndocument_id, e_document_type)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetDownloadUrlV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_download_url_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
e_document_type	String	The type of document to retrieve. 1. Initial Is the initial document before any signature were applied. 2. SignatureReady Is the version containing the annotations/form to show the signer. 3. Signed Is the final document once all signatures were applied in current document if eEzsignfolderCompletion is PerEzsigndocument.<br> Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. Proofdocument Is the evidence report. 5. Proof Is the complete evidence archive including all of the above and more.

Return type

EzsigndocumentGetDownloadUrlV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_ezsignannotations_v1

ezsigndocument_get_ezsignannotations_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's Ezsignannotations

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's Ezsignannotations
  result = api_instance.ezsigndocument_get_ezsignannotations_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignannotations_v1: #{e}"
end

Using the ezsigndocument_get_ezsignannotations_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_ezsignannotations_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's Ezsignannotations
  data, status_code, headers = api_instance.ezsigndocument_get_ezsignannotations_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetEzsignannotationsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignannotations_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetEzsignannotationsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_ezsigndiscussions_v1

ezsigndocument_get_ezsigndiscussions_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's Ezsigndiscussions

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's Ezsigndiscussions
  result = api_instance.ezsigndocument_get_ezsigndiscussions_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsigndiscussions_v1: #{e}"
end

Using the ezsigndocument_get_ezsigndiscussions_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_ezsigndiscussions_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's Ezsigndiscussions
  data, status_code, headers = api_instance.ezsigndocument_get_ezsigndiscussions_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetEzsigndiscussionsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsigndiscussions_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetEzsigndiscussionsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_ezsignformfieldgroups_v1

ezsigndocument_get_ezsignformfieldgroups_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's Ezsignformfieldgroups

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
  result = api_instance.ezsigndocument_get_ezsignformfieldgroups_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignformfieldgroups_v1: #{e}"
end

Using the ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
  data, status_code, headers = api_instance.ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetEzsignformfieldgroupsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetEzsignformfieldgroupsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_ezsignpages_v1

ezsigndocument_get_ezsignpages_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's Ezsignpages

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's Ezsignpages
  result = api_instance.ezsigndocument_get_ezsignpages_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignpages_v1: #{e}"
end

Using the ezsigndocument_get_ezsignpages_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_ezsignpages_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's Ezsignpages
  data, status_code, headers = api_instance.ezsigndocument_get_ezsignpages_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetEzsignpagesV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignpages_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetEzsignpagesV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_ezsignsignatures_automatic_v1

ezsigndocument_get_ezsignsignatures_automatic_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
  result = api_instance.ezsigndocument_get_ezsignsignatures_automatic_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignsignatures_automatic_v1: #{e}"
end

Using the ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
  data, status_code, headers = api_instance.ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetEzsignsignaturesAutomaticV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetEzsignsignaturesAutomaticV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_ezsignsignatures_v1

ezsigndocument_get_ezsignsignatures_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's Ezsignsignatures

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's Ezsignsignatures
  result = api_instance.ezsigndocument_get_ezsignsignatures_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignsignatures_v1: #{e}"
end

Using the ezsigndocument_get_ezsignsignatures_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's Ezsignsignatures
  data, status_code, headers = api_instance.ezsigndocument_get_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetEzsignsignaturesV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsignsignatures_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetEzsignsignaturesV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_form_data_v1

ezsigndocument_get_form_data_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument's Form Data

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument's Form Data
  result = api_instance.ezsigndocument_get_form_data_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_form_data_v1: #{e}"
end

Using the ezsigndocument_get_form_data_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_form_data_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument's Form Data
  data, status_code, headers = api_instance.ezsigndocument_get_form_data_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetFormDataV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_form_data_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetFormDataV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/zip, text/csv

ezsigndocument_get_object_v1

ezsigndocument_get_object_v1(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument
  result = api_instance.ezsigndocument_get_object_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_object_v1: #{e}"
end

Using the ezsigndocument_get_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_object_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_get_object_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_object_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_object_v2

ezsigndocument_get_object_v2(pki_ezsigndocument_id)

Retrieve an existing Ezsigndocument

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve an existing Ezsigndocument
  result = api_instance.ezsigndocument_get_object_v2(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_object_v2: #{e}"
end

Using the ezsigndocument_get_object_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_object_v2_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve an existing Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_get_object_v2_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetObjectV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_object_v2_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_temporary_proof_v1

ezsigndocument_get_temporary_proof_v1(pki_ezsigndocument_id)

Retrieve the temporary proof

Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 

begin
  # Retrieve the temporary proof
  result = api_instance.ezsigndocument_get_temporary_proof_v1(pki_ezsigndocument_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_temporary_proof_v1: #{e}"
end

Using the ezsigndocument_get_temporary_proof_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_temporary_proof_v1_with_http_info(pki_ezsigndocument_id)

begin
  # Retrieve the temporary proof
  data, status_code, headers = api_instance.ezsigndocument_get_temporary_proof_v1_with_http_info(pki_ezsigndocument_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetTemporaryProofV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_temporary_proof_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer

Return type

EzsigndocumentGetTemporaryProofV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ezsigndocument_get_words_positions_v1

ezsigndocument_get_words_positions_v1(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request)

Retrieve positions X,Y of given words from a Ezsigndocument

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_get_words_positions_v1_request = EzmaxApi::EzsigndocumentGetWordsPositionsV1Request.new({e_get: 'All', b_word_case_sensitive: false}) # EzsigndocumentGetWordsPositionsV1Request | 

begin
  # Retrieve positions X,Y of given words from a Ezsigndocument
  result = api_instance.ezsigndocument_get_words_positions_v1(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_words_positions_v1: #{e}"
end

Using the ezsigndocument_get_words_positions_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_get_words_positions_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request)

begin
  # Retrieve positions X,Y of given words from a Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_get_words_positions_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentGetWordsPositionsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_get_words_positions_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_get_words_positions_v1_request	EzsigndocumentGetWordsPositionsV1Request

Return type

EzsigndocumentGetWordsPositionsV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_patch_object_v1

ezsigndocument_patch_object_v1(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request)

Patch an existing Ezsigndocument

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_patch_object_v1_request = EzmaxApi::EzsigndocumentPatchObjectV1Request.new({obj_ezsigndocument: EzmaxApi::EzsigndocumentRequestPatch.new}) # EzsigndocumentPatchObjectV1Request | 

begin
  # Patch an existing Ezsigndocument
  result = api_instance.ezsigndocument_patch_object_v1(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_patch_object_v1: #{e}"
end

Using the ezsigndocument_patch_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_patch_object_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request)

begin
  # Patch an existing Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_patch_object_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentPatchObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_patch_object_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_patch_object_v1_request	EzsigndocumentPatchObjectV1Request

Return type

EzsigndocumentPatchObjectV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_submit_ezsignform_v1

ezsigndocument_submit_ezsignform_v1(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request)

Submit the Ezsignform

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
ezsigndocument_submit_ezsignform_v1_request = EzmaxApi::EzsigndocumentSubmitEzsignformV1Request.new({b_ezsignform_isdraft: false, a_obj_ezsignformfieldgroup: [EzmaxApi::CustomEzsignformfieldgroupRequest.new({a_obj_ezsignformfield: [EzmaxApi::CustomEzsignformfieldRequest.new]})]}) # EzsigndocumentSubmitEzsignformV1Request | 

begin
  # Submit the Ezsignform
  result = api_instance.ezsigndocument_submit_ezsignform_v1(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_submit_ezsignform_v1: #{e}"
end

Using the ezsigndocument_submit_ezsignform_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_submit_ezsignform_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request)

begin
  # Submit the Ezsignform
  data, status_code, headers = api_instance.ezsigndocument_submit_ezsignform_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentSubmitEzsignformV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_submit_ezsignform_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
ezsigndocument_submit_ezsignform_v1_request	EzsigndocumentSubmitEzsignformV1Request

Return type

EzsigndocumentSubmitEzsignformV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

ezsigndocument_unsend_v1

ezsigndocument_unsend_v1(pki_ezsigndocument_id, body)

Unsend the Ezsigndocument

Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectEzsigndocumentApi.new
pki_ezsigndocument_id = 56 # Integer | 
body = { ... } # Object | 

begin
  # Unsend the Ezsigndocument
  result = api_instance.ezsigndocument_unsend_v1(pki_ezsigndocument_id, body)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_unsend_v1: #{e}"
end

Using the ezsigndocument_unsend_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> ezsigndocument_unsend_v1_with_http_info(pki_ezsigndocument_id, body)

begin
  # Unsend the Ezsigndocument
  data, status_code, headers = api_instance.ezsigndocument_unsend_v1_with_http_info(pki_ezsigndocument_id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EzsigndocumentUnsendV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectEzsigndocumentApi->ezsigndocument_unsend_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
pki_ezsigndocument_id	Integer
body	Object

Return type

EzsigndocumentUnsendV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ObjectEzsigndocumentApi.md

Latest commit

History

ObjectEzsigndocumentApi.md

File metadata and controls

EzmaxApi::ObjectEzsigndocumentApi

ezsigndocument_apply_ezsigntemplate_v1

Examples

Using the ezsigndocument_apply_ezsigntemplate_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_apply_ezsigntemplate_v2

Examples

Using the ezsigndocument_apply_ezsigntemplate_v2_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_apply_ezsigntemplateglobal_v1

Examples

Using the ezsigndocument_apply_ezsigntemplateglobal_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_create_ezsignelements_positioned_by_word_v1

Examples

Using the ezsigndocument_create_ezsignelements_positioned_by_word_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_create_object_v1

Examples

Using the ezsigndocument_create_object_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_create_object_v2

Examples

Using the ezsigndocument_create_object_v2_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_decline_to_sign_v1

Examples

Using the ezsigndocument_decline_to_sign_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_delete_object_v1

Examples

Using the ezsigndocument_delete_object_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_edit_ezsignformfieldgroups_v1

Examples

Using the ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_edit_ezsignsignatures_v1

Examples

Using the ezsigndocument_edit_ezsignsignatures_v1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

ezsigndocument_end_prematurely_v1

Examples

Using the ezsigndocument_end_prematurely_v1_with_http_info variant