Skip to content

Latest commit

 

History

History
944 lines (649 loc) · 38.6 KB

ObjectEzsignfolderAPI.md

File metadata and controls

944 lines (649 loc) · 38.6 KB
Raw

ObjectEzsignfolderAPI

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

Method HTTP request Description
ObjectEzsignfolderAPI_ezsignfolderArchiveV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive Archive the Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderBatchDownloadV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload Download multiples files from an Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderCreateObjectV1 POST /1/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderCreateObjectV2 POST /2/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderDeleteObjectV1 DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderDisposeEzsignfoldersV1 POST /1/object/ezsignfolder/disposeEzsignfolders Dispose Ezsignfolders
ObjectEzsignfolderAPI_ezsignfolderDisposeV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose Dispose the Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderEditObjectV1 PUT /1/object/ezsignfolder/{pkiEzsignfolderID} Edit an existing Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderEndPrematurelyV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely End prematurely
ObjectEzsignfolderAPI_ezsignfolderGetActionableElementsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderGetAttachmentCountV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount Retrieve Attachment count
ObjectEzsignfolderAPI_ezsignfolderGetAttachmentsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments Retrieve Ezsignfolder's Attachments
ObjectEzsignfolderAPI_ezsignfolderGetCommunicationCountV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount Retrieve Communication count
ObjectEzsignfolderAPI_ezsignfolderGetCommunicationListV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList Retrieve Communication list
ObjectEzsignfolderAPI_ezsignfolderGetCommunicationrecipientsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients Retrieve Ezsignfolder's Communicationrecipient
ObjectEzsignfolderAPI_ezsignfolderGetCommunicationsendersV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders Retrieve Ezsignfolder's Communicationsender
ObjectEzsignfolderAPI_ezsignfolderGetEzsigndocumentsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
ObjectEzsignfolderAPI_ezsignfolderGetEzsignfoldersignerassociationsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ObjectEzsignfolderAPI_ezsignfolderGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ObjectEzsignfolderAPI_ezsignfolderGetFormsDataV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
ObjectEzsignfolderAPI_ezsignfolderGetListV1 GET /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
ObjectEzsignfolderAPI_ezsignfolderGetObjectV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderGetObjectV2 GET /2/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderImportEzsignfoldersignerassociationsV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderImportEzsigntemplatepackageV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Import an Ezsigntemplatepackage in the Ezsignfolder.
ObjectEzsignfolderAPI_ezsignfolderReorderV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder Reorder Ezsigndocuments in the Ezsignfolder
ObjectEzsignfolderAPI_ezsignfolderSendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderAPI_ezsignfolderSendV3 POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderAPI_ezsignfolderUnsendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder

ObjectEzsignfolderAPI_ezsignfolderArchiveV1

// Archive the Ezsignfolder
//
// 
//
ezsignfolder_archive_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderArchiveV1(apiClient_t *apiClient, int *pkiEzsignfolderID, object_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
body object_t *

Return type

ezsignfolder_archive_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderBatchDownloadV1

// Download multiples files from an Ezsignfolder
//
binary_t** ObjectEzsignfolderAPI_ezsignfolderBatchDownloadV1(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_batch_download_v1_request_t *ezsignfolder_batch_download_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_batch_download_v1_request ezsignfolder_batch_download_v1_request_t *

Return type

binary_t**

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/zip, application/json

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

ObjectEzsignfolderAPI_ezsignfolderCreateObjectV1

// Create a new Ezsignfolder
//
// 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.
//
ezsignfolder_create_object_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderCreateObjectV1(apiClient_t *apiClient, list_t *ezsignfolder_create_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
ezsignfolder_create_object_v1_request list_t *

Return type

ezsignfolder_create_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderCreateObjectV2

// Create a new Ezsignfolder
//
// The endpoint allows to create one or many elements at once.
//
ezsignfolder_create_object_v2_response_t* ObjectEzsignfolderAPI_ezsignfolderCreateObjectV2(apiClient_t *apiClient, ezsignfolder_create_object_v2_request_t *ezsignfolder_create_object_v2_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
ezsignfolder_create_object_v2_request ezsignfolder_create_object_v2_request_t *

Return type

ezsignfolder_create_object_v2_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderDeleteObjectV1

// Delete an existing Ezsignfolder
//
ezsignfolder_delete_object_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderDeleteObjectV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_delete_object_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderDisposeEzsignfoldersV1

// Dispose Ezsignfolders
//
// 
//
ezsignfolder_dispose_ezsignfolders_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderDisposeEzsignfoldersV1(apiClient_t *apiClient, ezsignfolder_dispose_ezsignfolders_v1_request_t *ezsignfolder_dispose_ezsignfolders_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
ezsignfolder_dispose_ezsignfolders_v1_request ezsignfolder_dispose_ezsignfolders_v1_request_t *

Return type

ezsignfolder_dispose_ezsignfolders_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderDisposeV1

// Dispose the Ezsignfolder
//
// 
//
ezsignfolder_dispose_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderDisposeV1(apiClient_t *apiClient, int *pkiEzsignfolderID, object_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
body object_t *

Return type

ezsignfolder_dispose_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderEditObjectV1

// Edit an existing Ezsignfolder
//
// 
//
ezsignfolder_edit_object_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderEditObjectV1(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_edit_object_v1_request_t *ezsignfolder_edit_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_edit_object_v1_request ezsignfolder_edit_object_v1_request_t *

Return type

ezsignfolder_edit_object_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderEndPrematurelyV1

// End prematurely
//
// End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required
//
ezsignfolder_end_prematurely_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderEndPrematurelyV1(apiClient_t *apiClient, int *pkiEzsignfolderID, object_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
body object_t *

Return type

ezsignfolder_end_prematurely_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderGetActionableElementsV1

// Retrieve actionable elements for the Ezsignfolder
//
// Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process
//
ezsignfolder_get_actionable_elements_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetActionableElementsV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_actionable_elements_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetAttachmentCountV1

// Retrieve Attachment count
//
// 
//
ezsignfolder_get_attachment_count_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetAttachmentCountV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_attachment_count_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetAttachmentsV1

// Retrieve Ezsignfolder's Attachments
//
// 
//
ezsignfolder_get_attachments_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetAttachmentsV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_attachments_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetCommunicationCountV1

// Retrieve Communication count
//
// 
//
ezsignfolder_get_communication_count_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetCommunicationCountV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_communication_count_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetCommunicationListV1

// Retrieve Communication list
//
// 
//
ezsignfolder_get_communication_list_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetCommunicationListV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_communication_list_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetCommunicationrecipientsV1

// Retrieve Ezsignfolder's Communicationrecipient
//
// 
//
ezsignfolder_get_communicationrecipients_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetCommunicationrecipientsV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_communicationrecipients_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetCommunicationsendersV1

// Retrieve Ezsignfolder's Communicationsender
//
// 
//
ezsignfolder_get_communicationsenders_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetCommunicationsendersV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_communicationsenders_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetEzsigndocumentsV1

// Retrieve an existing Ezsignfolder's Ezsigndocuments
//
// 
//
ezsignfolder_get_ezsigndocuments_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetEzsigndocumentsV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_ezsigndocuments_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetEzsignfoldersignerassociationsV1

// Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
//
// 
//
ezsignfolder_get_ezsignfoldersignerassociations_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetEzsignfoldersignerassociationsV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_ezsignfoldersignerassociations_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetEzsignsignaturesAutomaticV1

// Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
//
// Return the Ezsignsignatures that can be signed by the current user at the current step in the process
//
ezsignfolder_get_ezsignsignatures_automatic_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetEzsignsignaturesAutomaticV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_ezsignsignatures_automatic_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetFormsDataV1

// Retrieve an existing Ezsignfolder's forms data
//
// 
//
ezsignfolder_get_forms_data_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetFormsDataV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_forms_data_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderGetListV1

// Retrieve Ezsignfolder list
//
// Enum values that can be filtered in query parameter *sFilter*:  | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent<br>Sent<br>PartiallySigned<br>Expired<br>Completed<br>Archived<br>Disposed| | eEzsignfoldertypePrivacylevel | User<br>Usergroup |  Advanced filters that can be used in query parameter *sFilter*:  | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName |
//
ezsignfolder_get_list_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetListV1(apiClient_t *apiClient, ezmax_api_definition__full_ezsignfolderGetListV1_eOrderBy_e eOrderBy, int *iRowMax, int *iRowOffset, header_accept_language_e Accept_Language, char *sFilter);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
eOrderBy ezmax_api_definition__full_ezsignfolderGetListV1_eOrderBy_e Specify how you want the results to be sorted [optional]
iRowMax int * [optional]
iRowOffset int * [optional] [default to 0]
Accept_Language header_accept_language_e [optional]
sFilter char * [optional]

Return type

ezsignfolder_get_list_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

ObjectEzsignfolderAPI_ezsignfolderGetObjectV1

// Retrieve an existing Ezsignfolder
//
ezsignfolder_get_object_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderGetObjectV1(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_object_v1_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderGetObjectV2

// Retrieve an existing Ezsignfolder
//
// 
//
ezsignfolder_get_object_v2_response_t* ObjectEzsignfolderAPI_ezsignfolderGetObjectV2(apiClient_t *apiClient, int *pkiEzsignfolderID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *

Return type

ezsignfolder_get_object_v2_response_t *

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ObjectEzsignfolderAPI_ezsignfolderImportEzsignfoldersignerassociationsV1

// Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
//
// 
//
ezsignfolder_import_ezsignfoldersignerassociations_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderImportEzsignfoldersignerassociationsV1(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_import_ezsignfoldersignerassociations_v1_request_t *ezsignfolder_import_ezsignfoldersignerassociations_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_import_ezsignfoldersignerassociations_v1_request ezsignfolder_import_ezsignfoldersignerassociations_v1_request_t *

Return type

ezsignfolder_import_ezsignfoldersignerassociations_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderImportEzsigntemplatepackageV1

// Import an Ezsigntemplatepackage in the Ezsignfolder.
//
// This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments.  This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step.
//
ezsignfolder_import_ezsigntemplatepackage_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderImportEzsigntemplatepackageV1(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_import_ezsigntemplatepackage_v1_request_t *ezsignfolder_import_ezsigntemplatepackage_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_import_ezsigntemplatepackage_v1_request ezsignfolder_import_ezsigntemplatepackage_v1_request_t *

Return type

ezsignfolder_import_ezsigntemplatepackage_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderReorderV1

// Reorder Ezsigndocuments in the Ezsignfolder
//
ezsignfolder_reorder_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderReorderV1(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_reorder_v1_request_t *ezsignfolder_reorder_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_reorder_v1_request ezsignfolder_reorder_v1_request_t *

Return type

ezsignfolder_reorder_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderSendV1

// Send the Ezsignfolder to the signatories for signature
//
// 
//
ezsignfolder_send_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderSendV1(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_send_v1_request_t *ezsignfolder_send_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_send_v1_request ezsignfolder_send_v1_request_t *

Return type

ezsignfolder_send_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderSendV3

// Send the Ezsignfolder to the signatories for signature
//
// 
//
ezsignfolder_send_v3_response_t* ObjectEzsignfolderAPI_ezsignfolderSendV3(apiClient_t *apiClient, int *pkiEzsignfolderID, ezsignfolder_send_v3_request_t *ezsignfolder_send_v3_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
ezsignfolder_send_v3_request ezsignfolder_send_v3_request_t *

Return type

ezsignfolder_send_v3_response_t *

Authorization

Authorization

HTTP request headers

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

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

ObjectEzsignfolderAPI_ezsignfolderUnsendV1

// Unsend the Ezsignfolder
//
// Once an Ezsignfolder has been sent to signatories, it cannot be modified.  Using this endpoint, you can unsend the Ezsignfolder 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 \"Non-completed\" Ezsigndocuments will be lost.
//
ezsignfolder_unsend_v1_response_t* ObjectEzsignfolderAPI_ezsignfolderUnsendV1(apiClient_t *apiClient, int *pkiEzsignfolderID, object_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsignfolderID int *
body object_t *

Return type

ezsignfolder_unsend_v1_response_t *

Authorization

Authorization

HTTP request headers

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

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