eZmaxApi.Api.ObjectEzsignfolderApi

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

Method	HTTP request	Description
EzsignfolderArchiveV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive	Archive the Ezsignfolder
EzsignfolderBatchDownloadV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload	Download multiples files from an Ezsignfolder
EzsignfolderCreateObjectV1	POST /1/object/ezsignfolder	Create a new Ezsignfolder
EzsignfolderCreateObjectV2	POST /2/object/ezsignfolder	Create a new Ezsignfolder
EzsignfolderCreateObjectV3	POST /3/object/ezsignfolder	Create a new Ezsignfolder
EzsignfolderDeleteObjectV1	DELETE /1/object/ezsignfolder/{pkiEzsignfolderID}	Delete an existing Ezsignfolder
EzsignfolderDisposeEzsignfoldersV1	POST /1/object/ezsignfolder/disposeEzsignfolders	Dispose Ezsignfolders
EzsignfolderDisposeV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose	Dispose the Ezsignfolder
EzsignfolderEditObjectV3	PUT /3/object/ezsignfolder/{pkiEzsignfolderID}	Edit an existing Ezsignfolder
EzsignfolderEndPrematurelyV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely	End prematurely
EzsignfolderGetActionableElementsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements	Retrieve actionable elements for the Ezsignfolder
EzsignfolderGetAttachmentCountV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount	Retrieve Attachment count
EzsignfolderGetAttachmentsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments	Retrieve Ezsignfolder's Attachments
EzsignfolderGetCommunicationCountV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount	Retrieve Communication count
EzsignfolderGetCommunicationListV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList	Retrieve Communication list
EzsignfolderGetCommunicationrecipientsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients	Retrieve Ezsignfolder's Communicationrecipient
EzsignfolderGetCommunicationsendersV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders	Retrieve Ezsignfolder's Communicationsender
EzsignfolderGetEzsigndocumentsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments	Retrieve an existing Ezsignfolder's Ezsigndocuments
EzsignfolderGetEzsignfoldersignerassociationsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations	Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
EzsignfolderGetEzsignsignaturesAutomaticV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic	Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
EzsignfolderGetFormsDataV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData	Retrieve an existing Ezsignfolder's forms data
EzsignfolderGetListV1	GET /1/object/ezsignfolder/getList	Retrieve Ezsignfolder list
EzsignfolderGetObjectV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
EzsignfolderGetObjectV2	GET /2/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
EzsignfolderGetObjectV3	GET /3/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
EzsignfolderImportEzsignfoldersignerassociationsV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations	Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
EzsignfolderImportEzsigntemplatepackageV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage	Import an Ezsigntemplatepackage in the Ezsignfolder.
EzsignfolderReorderV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder	Reorder Ezsigndocuments in the Ezsignfolder
EzsignfolderReorderV2	POST /2/object/ezsignfolder/{pkiEzsignfolderID}/reorder	Reorder Ezsigndocuments in the Ezsignfolder
EzsignfolderSendV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
EzsignfolderSendV3	POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
EzsignfolderUnsendV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend	Unsend the Ezsignfolder

EzsignfolderArchiveV1

EzsignfolderArchiveV1Response EzsignfolderArchiveV1 (int pkiEzsignfolderID, Object body)

Archive the Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderArchiveV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var body = null;  // Object | 

            try
            {
                // Archive the Ezsignfolder
                EzsignfolderArchiveV1Response result = apiInstance.EzsignfolderArchiveV1(pkiEzsignfolderID, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderArchiveV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderArchiveV1WithHttpInfo variant

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

try
{
    // Archive the Ezsignfolder
    ApiResponse<EzsignfolderArchiveV1Response> response = apiInstance.EzsignfolderArchiveV1WithHttpInfo(pkiEzsignfolderID, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderArchiveV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
body	Object

Return type

EzsignfolderArchiveV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderBatchDownloadV1

System.IO.Stream EzsignfolderBatchDownloadV1 (int pkiEzsignfolderID, EzsignfolderBatchDownloadV1Request ezsignfolderBatchDownloadV1Request)

Download multiples files from an Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderBatchDownloadV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderBatchDownloadV1Request = new EzsignfolderBatchDownloadV1Request(); // EzsignfolderBatchDownloadV1Request | 

            try
            {
                // Download multiples files from an Ezsignfolder
                System.IO.Stream result = apiInstance.EzsignfolderBatchDownloadV1(pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderBatchDownloadV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderBatchDownloadV1WithHttpInfo variant

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

try
{
    // Download multiples files from an Ezsignfolder
    ApiResponse<System.IO.Stream> response = apiInstance.EzsignfolderBatchDownloadV1WithHttpInfo(pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderBatchDownloadV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderBatchDownloadV1Request	EzsignfolderBatchDownloadV1Request

Return type

System.IO.Stream

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderCreateObjectV1

EzsignfolderCreateObjectV1Response EzsignfolderCreateObjectV1 (List ezsignfolderCreateObjectV1Request)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderCreateObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var ezsignfolderCreateObjectV1Request = new List<EzsignfolderCreateObjectV1Request>(); // List<EzsignfolderCreateObjectV1Request> | 

            try
            {
                // Create a new Ezsignfolder
                EzsignfolderCreateObjectV1Response result = apiInstance.EzsignfolderCreateObjectV1(ezsignfolderCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderCreateObjectV1WithHttpInfo variant

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

try
{
    // Create a new Ezsignfolder
    ApiResponse<EzsignfolderCreateObjectV1Response> response = apiInstance.EzsignfolderCreateObjectV1WithHttpInfo(ezsignfolderCreateObjectV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV1Request	List<EzsignfolderCreateObjectV1Request>

Return type

EzsignfolderCreateObjectV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-

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

EzsignfolderCreateObjectV2

EzsignfolderCreateObjectV2Response EzsignfolderCreateObjectV2 (EzsignfolderCreateObjectV2Request ezsignfolderCreateObjectV2Request)

Create a new Ezsignfolder

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderCreateObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var ezsignfolderCreateObjectV2Request = new EzsignfolderCreateObjectV2Request(); // EzsignfolderCreateObjectV2Request | 

            try
            {
                // Create a new Ezsignfolder
                EzsignfolderCreateObjectV2Response result = apiInstance.EzsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderCreateObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderCreateObjectV2WithHttpInfo variant

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

try
{
    // Create a new Ezsignfolder
    ApiResponse<EzsignfolderCreateObjectV2Response> response = apiInstance.EzsignfolderCreateObjectV2WithHttpInfo(ezsignfolderCreateObjectV2Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderCreateObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV2Request	EzsignfolderCreateObjectV2Request

Return type

EzsignfolderCreateObjectV2Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-

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

EzsignfolderCreateObjectV3

EzsignfolderCreateObjectV3Response EzsignfolderCreateObjectV3 (EzsignfolderCreateObjectV3Request ezsignfolderCreateObjectV3Request)

Create a new Ezsignfolder

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderCreateObjectV3Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var ezsignfolderCreateObjectV3Request = new EzsignfolderCreateObjectV3Request(); // EzsignfolderCreateObjectV3Request | 

            try
            {
                // Create a new Ezsignfolder
                EzsignfolderCreateObjectV3Response result = apiInstance.EzsignfolderCreateObjectV3(ezsignfolderCreateObjectV3Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderCreateObjectV3: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderCreateObjectV3WithHttpInfo variant

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

try
{
    // Create a new Ezsignfolder
    ApiResponse<EzsignfolderCreateObjectV3Response> response = apiInstance.EzsignfolderCreateObjectV3WithHttpInfo(ezsignfolderCreateObjectV3Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderCreateObjectV3WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV3Request	EzsignfolderCreateObjectV3Request

Return type

EzsignfolderCreateObjectV3Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-

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

EzsignfolderDeleteObjectV1

EzsignfolderDeleteObjectV1Response EzsignfolderDeleteObjectV1 (int pkiEzsignfolderID)

Delete an existing Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderDeleteObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Delete an existing Ezsignfolder
                EzsignfolderDeleteObjectV1Response result = apiInstance.EzsignfolderDeleteObjectV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderDeleteObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderDeleteObjectV1WithHttpInfo variant

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

try
{
    // Delete an existing Ezsignfolder
    ApiResponse<EzsignfolderDeleteObjectV1Response> response = apiInstance.EzsignfolderDeleteObjectV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderDeleteObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderDisposeEzsignfoldersV1

EzsignfolderDisposeEzsignfoldersV1Response EzsignfolderDisposeEzsignfoldersV1 (EzsignfolderDisposeEzsignfoldersV1Request ezsignfolderDisposeEzsignfoldersV1Request)

Dispose Ezsignfolders

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderDisposeEzsignfoldersV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var ezsignfolderDisposeEzsignfoldersV1Request = new EzsignfolderDisposeEzsignfoldersV1Request(); // EzsignfolderDisposeEzsignfoldersV1Request | 

            try
            {
                // Dispose Ezsignfolders
                EzsignfolderDisposeEzsignfoldersV1Response result = apiInstance.EzsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderDisposeEzsignfoldersV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderDisposeEzsignfoldersV1WithHttpInfo variant

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

try
{
    // Dispose Ezsignfolders
    ApiResponse<EzsignfolderDisposeEzsignfoldersV1Response> response = apiInstance.EzsignfolderDisposeEzsignfoldersV1WithHttpInfo(ezsignfolderDisposeEzsignfoldersV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderDisposeEzsignfoldersV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
ezsignfolderDisposeEzsignfoldersV1Request	EzsignfolderDisposeEzsignfoldersV1Request

Return type

EzsignfolderDisposeEzsignfoldersV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderDisposeV1

EzsignfolderDisposeV1Response EzsignfolderDisposeV1 (int pkiEzsignfolderID, Object body)

Dispose the Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderDisposeV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var body = null;  // Object | 

            try
            {
                // Dispose the Ezsignfolder
                EzsignfolderDisposeV1Response result = apiInstance.EzsignfolderDisposeV1(pkiEzsignfolderID, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderDisposeV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderDisposeV1WithHttpInfo variant

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

try
{
    // Dispose the Ezsignfolder
    ApiResponse<EzsignfolderDisposeV1Response> response = apiInstance.EzsignfolderDisposeV1WithHttpInfo(pkiEzsignfolderID, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderDisposeV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
body	Object

Return type

EzsignfolderDisposeV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderEditObjectV3

EzsignfolderEditObjectV3Response EzsignfolderEditObjectV3 (int pkiEzsignfolderID, EzsignfolderEditObjectV3Request ezsignfolderEditObjectV3Request)

Edit an existing Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderEditObjectV3Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderEditObjectV3Request = new EzsignfolderEditObjectV3Request(); // EzsignfolderEditObjectV3Request | 

            try
            {
                // Edit an existing Ezsignfolder
                EzsignfolderEditObjectV3Response result = apiInstance.EzsignfolderEditObjectV3(pkiEzsignfolderID, ezsignfolderEditObjectV3Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderEditObjectV3: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderEditObjectV3WithHttpInfo variant

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

try
{
    // Edit an existing Ezsignfolder
    ApiResponse<EzsignfolderEditObjectV3Response> response = apiInstance.EzsignfolderEditObjectV3WithHttpInfo(pkiEzsignfolderID, ezsignfolderEditObjectV3Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderEditObjectV3WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderEditObjectV3Request	EzsignfolderEditObjectV3Request

Return type

EzsignfolderEditObjectV3Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderEndPrematurelyV1

EzsignfolderEndPrematurelyV1Response EzsignfolderEndPrematurelyV1 (int pkiEzsignfolderID, Object body)

End prematurely

End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderEndPrematurelyV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var body = null;  // Object | 

            try
            {
                // End prematurely
                EzsignfolderEndPrematurelyV1Response result = apiInstance.EzsignfolderEndPrematurelyV1(pkiEzsignfolderID, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderEndPrematurelyV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderEndPrematurelyV1WithHttpInfo variant

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

try
{
    // End prematurely
    ApiResponse<EzsignfolderEndPrematurelyV1Response> response = apiInstance.EzsignfolderEndPrematurelyV1WithHttpInfo(pkiEzsignfolderID, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderEndPrematurelyV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
body	Object

Return type

EzsignfolderEndPrematurelyV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderGetActionableElementsV1

EzsignfolderGetActionableElementsV1Response EzsignfolderGetActionableElementsV1 (int pkiEzsignfolderID)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetActionableElementsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve actionable elements for the Ezsignfolder
                EzsignfolderGetActionableElementsV1Response result = apiInstance.EzsignfolderGetActionableElementsV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetActionableElementsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetActionableElementsV1WithHttpInfo variant

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

try
{
    // Retrieve actionable elements for the Ezsignfolder
    ApiResponse<EzsignfolderGetActionableElementsV1Response> response = apiInstance.EzsignfolderGetActionableElementsV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetActionableElementsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetActionableElementsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderGetAttachmentCountV1

EzsignfolderGetAttachmentCountV1Response EzsignfolderGetAttachmentCountV1 (int pkiEzsignfolderID)

Retrieve Attachment count

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetAttachmentCountV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve Attachment count
                EzsignfolderGetAttachmentCountV1Response result = apiInstance.EzsignfolderGetAttachmentCountV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetAttachmentCountV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetAttachmentCountV1WithHttpInfo variant

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

try
{
    // Retrieve Attachment count
    ApiResponse<EzsignfolderGetAttachmentCountV1Response> response = apiInstance.EzsignfolderGetAttachmentCountV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetAttachmentCountV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetAttachmentCountV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetAttachmentsV1

EzsignfolderGetAttachmentsV1Response EzsignfolderGetAttachmentsV1 (int pkiEzsignfolderID)

Retrieve Ezsignfolder's Attachments

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetAttachmentsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve Ezsignfolder's Attachments
                EzsignfolderGetAttachmentsV1Response result = apiInstance.EzsignfolderGetAttachmentsV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetAttachmentsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetAttachmentsV1WithHttpInfo variant

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

try
{
    // Retrieve Ezsignfolder's Attachments
    ApiResponse<EzsignfolderGetAttachmentsV1Response> response = apiInstance.EzsignfolderGetAttachmentsV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetAttachmentsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetAttachmentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetCommunicationCountV1

EzsignfolderGetCommunicationCountV1Response EzsignfolderGetCommunicationCountV1 (int pkiEzsignfolderID)

Retrieve Communication count

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetCommunicationCountV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve Communication count
                EzsignfolderGetCommunicationCountV1Response result = apiInstance.EzsignfolderGetCommunicationCountV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationCountV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetCommunicationCountV1WithHttpInfo variant

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

try
{
    // Retrieve Communication count
    ApiResponse<EzsignfolderGetCommunicationCountV1Response> response = apiInstance.EzsignfolderGetCommunicationCountV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationCountV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetCommunicationCountV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetCommunicationListV1

EzsignfolderGetCommunicationListV1Response EzsignfolderGetCommunicationListV1 (int pkiEzsignfolderID)

Retrieve Communication list

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetCommunicationListV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve Communication list
                EzsignfolderGetCommunicationListV1Response result = apiInstance.EzsignfolderGetCommunicationListV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetCommunicationListV1WithHttpInfo variant

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

try
{
    // Retrieve Communication list
    ApiResponse<EzsignfolderGetCommunicationListV1Response> response = apiInstance.EzsignfolderGetCommunicationListV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetCommunicationListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetCommunicationrecipientsV1

EzsignfolderGetCommunicationrecipientsV1Response EzsignfolderGetCommunicationrecipientsV1 (int pkiEzsignfolderID)

Retrieve Ezsignfolder's Communicationrecipient

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetCommunicationrecipientsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve Ezsignfolder's Communicationrecipient
                EzsignfolderGetCommunicationrecipientsV1Response result = apiInstance.EzsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationrecipientsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetCommunicationrecipientsV1WithHttpInfo variant

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

try
{
    // Retrieve Ezsignfolder's Communicationrecipient
    ApiResponse<EzsignfolderGetCommunicationrecipientsV1Response> response = apiInstance.EzsignfolderGetCommunicationrecipientsV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationrecipientsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetCommunicationrecipientsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetCommunicationsendersV1

EzsignfolderGetCommunicationsendersV1Response EzsignfolderGetCommunicationsendersV1 (int pkiEzsignfolderID)

Retrieve Ezsignfolder's Communicationsender

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetCommunicationsendersV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve Ezsignfolder's Communicationsender
                EzsignfolderGetCommunicationsendersV1Response result = apiInstance.EzsignfolderGetCommunicationsendersV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationsendersV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetCommunicationsendersV1WithHttpInfo variant

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

try
{
    // Retrieve Ezsignfolder's Communicationsender
    ApiResponse<EzsignfolderGetCommunicationsendersV1Response> response = apiInstance.EzsignfolderGetCommunicationsendersV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetCommunicationsendersV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetCommunicationsendersV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetEzsigndocumentsV1

EzsignfolderGetEzsigndocumentsV1Response EzsignfolderGetEzsigndocumentsV1 (int pkiEzsignfolderID)

Retrieve an existing Ezsignfolder's Ezsigndocuments

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetEzsigndocumentsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder's Ezsigndocuments
                EzsignfolderGetEzsigndocumentsV1Response result = apiInstance.EzsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetEzsigndocumentsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetEzsigndocumentsV1WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder's Ezsigndocuments
    ApiResponse<EzsignfolderGetEzsigndocumentsV1Response> response = apiInstance.EzsignfolderGetEzsigndocumentsV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetEzsigndocumentsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetEzsigndocumentsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetEzsignfoldersignerassociationsV1

EzsignfolderGetEzsignfoldersignerassociationsV1Response EzsignfolderGetEzsignfoldersignerassociationsV1 (int pkiEzsignfolderID)

Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetEzsignfoldersignerassociationsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
                EzsignfolderGetEzsignfoldersignerassociationsV1Response result = apiInstance.EzsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetEzsignfoldersignerassociationsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetEzsignfoldersignerassociationsV1WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
    ApiResponse<EzsignfolderGetEzsignfoldersignerassociationsV1Response> response = apiInstance.EzsignfolderGetEzsignfoldersignerassociationsV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetEzsignfoldersignerassociationsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetEzsignfoldersignerassociationsV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetEzsignsignaturesAutomaticV1

EzsignfolderGetEzsignsignaturesAutomaticV1Response EzsignfolderGetEzsignsignaturesAutomaticV1 (int pkiEzsignfolderID)

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetEzsignsignaturesAutomaticV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
                EzsignfolderGetEzsignsignaturesAutomaticV1Response result = apiInstance.EzsignfolderGetEzsignsignaturesAutomaticV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetEzsignsignaturesAutomaticV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetEzsignsignaturesAutomaticV1WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
    ApiResponse<EzsignfolderGetEzsignsignaturesAutomaticV1Response> response = apiInstance.EzsignfolderGetEzsignsignaturesAutomaticV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetEzsignsignaturesAutomaticV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetEzsignsignaturesAutomaticV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetFormsDataV1

EzsignfolderGetFormsDataV1Response EzsignfolderGetFormsDataV1 (int pkiEzsignfolderID)

Retrieve an existing Ezsignfolder's forms data

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetFormsDataV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder's forms data
                EzsignfolderGetFormsDataV1Response result = apiInstance.EzsignfolderGetFormsDataV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetFormsDataV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetFormsDataV1WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder's forms data
    ApiResponse<EzsignfolderGetFormsDataV1Response> response = apiInstance.EzsignfolderGetFormsDataV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetFormsDataV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetFormsDataV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderGetListV1

EzsignfolderGetListV1Response EzsignfolderGetListV1 (string? eOrderBy = null, int? iRowMax = null, int? iRowOffset = null, HeaderAcceptLanguage? acceptLanguage = null, string? sFilter = null)

Retrieve Ezsignfolder list

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetListV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var eOrderBy = "pkiEzsignfolderID_ASC";  // string? | Specify how you want the results to be sorted (optional) 
            var iRowMax = 56;  // int? |  (optional) 
            var iRowOffset = 0;  // int? |  (optional)  (default to 0)
            var acceptLanguage = new HeaderAcceptLanguage?(); // HeaderAcceptLanguage? |  (optional) 
            var sFilter = "sFilter_example";  // string? |  (optional) 

            try
            {
                // Retrieve Ezsignfolder list
                EzsignfolderGetListV1Response result = apiInstance.EzsignfolderGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetListV1WithHttpInfo variant

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

try
{
    // Retrieve Ezsignfolder list
    ApiResponse<EzsignfolderGetListV1Response> response = apiInstance.EzsignfolderGetListV1WithHttpInfo(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
eOrderBy	string?	Specify how you want the results to be sorted	[optional]
iRowMax	int?		[optional]
iRowOffset	int?		[optional] [default to 0]
acceptLanguage	HeaderAcceptLanguage?		[optional]
sFilter	string?		[optional]

Return type

EzsignfolderGetListV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

EzsignfolderGetObjectV1

EzsignfolderGetObjectV1Response EzsignfolderGetObjectV1 (int pkiEzsignfolderID)

Retrieve an existing Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder
                EzsignfolderGetObjectV1Response result = apiInstance.EzsignfolderGetObjectV1(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetObjectV1WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder
    ApiResponse<EzsignfolderGetObjectV1Response> response = apiInstance.EzsignfolderGetObjectV1WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetObjectV2

EzsignfolderGetObjectV2Response EzsignfolderGetObjectV2 (int pkiEzsignfolderID)

Retrieve an existing Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder
                EzsignfolderGetObjectV2Response result = apiInstance.EzsignfolderGetObjectV2(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder
    ApiResponse<EzsignfolderGetObjectV2Response> response = apiInstance.EzsignfolderGetObjectV2WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderGetObjectV3

EzsignfolderGetObjectV3Response EzsignfolderGetObjectV3 (int pkiEzsignfolderID)

Retrieve an existing Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderGetObjectV3Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfolder
                EzsignfolderGetObjectV3Response result = apiInstance.EzsignfolderGetObjectV3(pkiEzsignfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetObjectV3: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderGetObjectV3WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfolder
    ApiResponse<EzsignfolderGetObjectV3Response> response = apiInstance.EzsignfolderGetObjectV3WithHttpInfo(pkiEzsignfolderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderGetObjectV3WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int

Return type

EzsignfolderGetObjectV3Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

EzsignfolderImportEzsignfoldersignerassociationsV1

EzsignfolderImportEzsignfoldersignerassociationsV1Response EzsignfolderImportEzsignfoldersignerassociationsV1 (int pkiEzsignfolderID, EzsignfolderImportEzsignfoldersignerassociationsV1Request ezsignfolderImportEzsignfoldersignerassociationsV1Request)

Import an existing Ezsignfoldersignerassociation into this Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderImportEzsignfoldersignerassociationsV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderImportEzsignfoldersignerassociationsV1Request = new EzsignfolderImportEzsignfoldersignerassociationsV1Request(); // EzsignfolderImportEzsignfoldersignerassociationsV1Request | 

            try
            {
                // Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
                EzsignfolderImportEzsignfoldersignerassociationsV1Response result = apiInstance.EzsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderImportEzsignfoldersignerassociationsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderImportEzsignfoldersignerassociationsV1WithHttpInfo variant

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

try
{
    // Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
    ApiResponse<EzsignfolderImportEzsignfoldersignerassociationsV1Response> response = apiInstance.EzsignfolderImportEzsignfoldersignerassociationsV1WithHttpInfo(pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderImportEzsignfoldersignerassociationsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderImportEzsignfoldersignerassociationsV1Request	EzsignfolderImportEzsignfoldersignerassociationsV1Request

Return type

EzsignfolderImportEzsignfoldersignerassociationsV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
403	The request is not allowed to be executed. Look for detail about the error in the body	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderImportEzsigntemplatepackageV1

EzsignfolderImportEzsigntemplatepackageV1Response EzsignfolderImportEzsigntemplatepackageV1 (int pkiEzsignfolderID, EzsignfolderImportEzsigntemplatepackageV1Request ezsignfolderImportEzsigntemplatepackageV1Request)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderImportEzsigntemplatepackageV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderImportEzsigntemplatepackageV1Request = new EzsignfolderImportEzsigntemplatepackageV1Request(); // EzsignfolderImportEzsigntemplatepackageV1Request | 

            try
            {
                // Import an Ezsigntemplatepackage in the Ezsignfolder.
                EzsignfolderImportEzsigntemplatepackageV1Response result = apiInstance.EzsignfolderImportEzsigntemplatepackageV1(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderImportEzsigntemplatepackageV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderImportEzsigntemplatepackageV1WithHttpInfo variant

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

try
{
    // Import an Ezsigntemplatepackage in the Ezsignfolder.
    ApiResponse<EzsignfolderImportEzsigntemplatepackageV1Response> response = apiInstance.EzsignfolderImportEzsigntemplatepackageV1WithHttpInfo(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderImportEzsigntemplatepackageV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderImportEzsigntemplatepackageV1Request	EzsignfolderImportEzsigntemplatepackageV1Request

Return type

EzsignfolderImportEzsigntemplatepackageV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderReorderV1

EzsignfolderReorderV1Response EzsignfolderReorderV1 (int pkiEzsignfolderID, EzsignfolderReorderV1Request ezsignfolderReorderV1Request)

Reorder Ezsigndocuments in the Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderReorderV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderReorderV1Request = new EzsignfolderReorderV1Request(); // EzsignfolderReorderV1Request | 

            try
            {
                // Reorder Ezsigndocuments in the Ezsignfolder
                EzsignfolderReorderV1Response result = apiInstance.EzsignfolderReorderV1(pkiEzsignfolderID, ezsignfolderReorderV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderReorderV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderReorderV1WithHttpInfo variant

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

try
{
    // Reorder Ezsigndocuments in the Ezsignfolder
    ApiResponse<EzsignfolderReorderV1Response> response = apiInstance.EzsignfolderReorderV1WithHttpInfo(pkiEzsignfolderID, ezsignfolderReorderV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderReorderV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderReorderV1Request	EzsignfolderReorderV1Request

Return type

EzsignfolderReorderV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderReorderV2

EzsignfolderReorderV2Response EzsignfolderReorderV2 (int pkiEzsignfolderID, EzsignfolderReorderV2Request ezsignfolderReorderV2Request)

Reorder Ezsigndocuments in the Ezsignfolder

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderReorderV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderReorderV2Request = new EzsignfolderReorderV2Request(); // EzsignfolderReorderV2Request | 

            try
            {
                // Reorder Ezsigndocuments in the Ezsignfolder
                EzsignfolderReorderV2Response result = apiInstance.EzsignfolderReorderV2(pkiEzsignfolderID, ezsignfolderReorderV2Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderReorderV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderReorderV2WithHttpInfo variant

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

try
{
    // Reorder Ezsigndocuments in the Ezsignfolder
    ApiResponse<EzsignfolderReorderV2Response> response = apiInstance.EzsignfolderReorderV2WithHttpInfo(pkiEzsignfolderID, ezsignfolderReorderV2Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderReorderV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderReorderV2Request	EzsignfolderReorderV2Request

Return type

EzsignfolderReorderV2Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderSendV1

EzsignfolderSendV1Response EzsignfolderSendV1 (int pkiEzsignfolderID, EzsignfolderSendV1Request ezsignfolderSendV1Request)

Send the Ezsignfolder to the signatories for signature

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderSendV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderSendV1Request = new EzsignfolderSendV1Request(); // EzsignfolderSendV1Request | 

            try
            {
                // Send the Ezsignfolder to the signatories for signature
                EzsignfolderSendV1Response result = apiInstance.EzsignfolderSendV1(pkiEzsignfolderID, ezsignfolderSendV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderSendV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderSendV1WithHttpInfo variant

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

try
{
    // Send the Ezsignfolder to the signatories for signature
    ApiResponse<EzsignfolderSendV1Response> response = apiInstance.EzsignfolderSendV1WithHttpInfo(pkiEzsignfolderID, ezsignfolderSendV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderSendV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderSendV1Request	EzsignfolderSendV1Request

Return type

EzsignfolderSendV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderSendV3

EzsignfolderSendV3Response EzsignfolderSendV3 (int pkiEzsignfolderID, EzsignfolderSendV3Request ezsignfolderSendV3Request)

Send the Ezsignfolder to the signatories for signature

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderSendV3Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var ezsignfolderSendV3Request = new EzsignfolderSendV3Request(); // EzsignfolderSendV3Request | 

            try
            {
                // Send the Ezsignfolder to the signatories for signature
                EzsignfolderSendV3Response result = apiInstance.EzsignfolderSendV3(pkiEzsignfolderID, ezsignfolderSendV3Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderSendV3: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderSendV3WithHttpInfo variant

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

try
{
    // Send the Ezsignfolder to the signatories for signature
    ApiResponse<EzsignfolderSendV3Response> response = apiInstance.EzsignfolderSendV3WithHttpInfo(pkiEzsignfolderID, ezsignfolderSendV3Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderSendV3WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
ezsignfolderSendV3Request	EzsignfolderSendV3Request

Return type

EzsignfolderSendV3Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

EzsignfolderUnsendV1

EzsignfolderUnsendV1Response EzsignfolderUnsendV1 (int pkiEzsignfolderID, Object body)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class EzsignfolderUnsendV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectEzsignfolderApi(config);
            var pkiEzsignfolderID = 56;  // int | 
            var body = null;  // Object | 

            try
            {
                // Unsend the Ezsignfolder
                EzsignfolderUnsendV1Response result = apiInstance.EzsignfolderUnsendV1(pkiEzsignfolderID, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderUnsendV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfolderUnsendV1WithHttpInfo variant

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

try
{
    // Unsend the Ezsignfolder
    ApiResponse<EzsignfolderUnsendV1Response> response = apiInstance.EzsignfolderUnsendV1WithHttpInfo(pkiEzsignfolderID, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectEzsignfolderApi.EzsignfolderUnsendV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	int
body	Object

Return type

EzsignfolderUnsendV1Response

Authorization

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

Files

ObjectEzsignfolderApi.md

Latest commit

History

ObjectEzsignfolderApi.md

File metadata and controls

eZmaxApi.Api.ObjectEzsignfolderApi

EzsignfolderArchiveV1

Example

Using the EzsignfolderArchiveV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderBatchDownloadV1

Example

Using the EzsignfolderBatchDownloadV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderCreateObjectV1

Example

Using the EzsignfolderCreateObjectV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderCreateObjectV2

Example

Using the EzsignfolderCreateObjectV2WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderCreateObjectV3

Example

Using the EzsignfolderCreateObjectV3WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderDeleteObjectV1

Example

Using the EzsignfolderDeleteObjectV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderDisposeEzsignfoldersV1

Example

Using the EzsignfolderDisposeEzsignfoldersV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderDisposeV1

Example

Using the EzsignfolderDisposeV1WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderEditObjectV3

Example

Using the EzsignfolderEditObjectV3WithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

EzsignfolderEndPrematurelyV1