eZmaxApi.ObjectEzsignfolderApi

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

Method	HTTP request	Description
ezsignfolder_archive_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive	Archive the Ezsignfolder
ezsignfolder_batch_download_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload	Download multiples files from an Ezsignfolder
ezsignfolder_create_object_v1	POST /1/object/ezsignfolder	Create a new Ezsignfolder
ezsignfolder_create_object_v2	POST /2/object/ezsignfolder	Create a new Ezsignfolder
ezsignfolder_delete_object_v1	DELETE /1/object/ezsignfolder/{pkiEzsignfolderID}	Delete an existing Ezsignfolder
ezsignfolder_dispose_ezsignfolders_v1	POST /1/object/ezsignfolder/disposeEzsignfolders	Dispose Ezsignfolders
ezsignfolder_dispose_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose	Dispose the Ezsignfolder
ezsignfolder_edit_object_v1	PUT /1/object/ezsignfolder/{pkiEzsignfolderID}	Edit an existing Ezsignfolder
ezsignfolder_end_prematurely_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely	End prematurely
ezsignfolder_get_actionable_elements_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements	Retrieve actionable elements for the Ezsignfolder
ezsignfolder_get_attachment_count_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount	Retrieve Attachment count
ezsignfolder_get_attachments_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments	Retrieve Ezsignfolder's Attachments
ezsignfolder_get_communication_count_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount	Retrieve Communication count
ezsignfolder_get_communication_list_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList	Retrieve Communication list
ezsignfolder_get_communicationrecipients_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients	Retrieve Ezsignfolder's Communicationrecipient
ezsignfolder_get_communicationsenders_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders	Retrieve Ezsignfolder's Communicationsender
ezsignfolder_get_ezsigndocuments_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments	Retrieve an existing Ezsignfolder's Ezsigndocuments
ezsignfolder_get_ezsignfoldersignerassociations_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations	Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ezsignfolder_get_ezsignsignatures_automatic_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic	Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ezsignfolder_get_forms_data_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData	Retrieve an existing Ezsignfolder's forms data
ezsignfolder_get_list_v1	GET /1/object/ezsignfolder/getList	Retrieve Ezsignfolder list
ezsignfolder_get_object_v1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
ezsignfolder_get_object_v2	GET /2/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
ezsignfolder_import_ezsignfoldersignerassociations_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations	Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ezsignfolder_import_ezsigntemplatepackage_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage	Import an Ezsigntemplatepackage in the Ezsignfolder.
ezsignfolder_reorder_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder	Reorder Ezsigndocuments in the Ezsignfolder
ezsignfolder_send_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
ezsignfolder_send_v3	POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
ezsignfolder_unsend_v1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend	Unsend the Ezsignfolder

ezsignfolder_archive_v1

EzsignfolderArchiveV1Response ezsignfolder_archive_v1(pki_ezsignfolder_id, body)

Archive the Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_archive_v1_response import EzsignfolderArchiveV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    body = None # object | 

    try:
        # Archive the Ezsignfolder
        api_response = api_instance.ezsignfolder_archive_v1(pki_ezsignfolder_id, body)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_archive_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_archive_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_batch_download_v1

bytearray ezsignfolder_batch_download_v1(pki_ezsignfolder_id, ezsignfolder_batch_download_v1_request)

Download multiples files from an Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_batch_download_v1_request import EzsignfolderBatchDownloadV1Request
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_batch_download_v1_request = eZmaxApi.EzsignfolderBatchDownloadV1Request() # EzsignfolderBatchDownloadV1Request | 

    try:
        # Download multiples files from an Ezsignfolder
        api_response = api_instance.ezsignfolder_batch_download_v1(pki_ezsignfolder_id, ezsignfolder_batch_download_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_batch_download_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_batch_download_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_batch_download_v1_request	EzsignfolderBatchDownloadV1Request

Return type

bytearray

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]

ezsignfolder_create_object_v1

EzsignfolderCreateObjectV1Response ezsignfolder_create_object_v1(ezsignfolder_create_object_v1_request)

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

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_create_object_v1_request import EzsignfolderCreateObjectV1Request
from eZmaxApi.models.ezsignfolder_create_object_v1_response import EzsignfolderCreateObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    ezsignfolder_create_object_v1_request = [eZmaxApi.EzsignfolderCreateObjectV1Request()] # List[EzsignfolderCreateObjectV1Request] | 

    try:
        # Create a new Ezsignfolder
        api_response = api_instance.ezsignfolder_create_object_v1(ezsignfolder_create_object_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_create_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_create_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
ezsignfolder_create_object_v1_request	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]

ezsignfolder_create_object_v2

EzsignfolderCreateObjectV2Response ezsignfolder_create_object_v2(ezsignfolder_create_object_v2_request)

Create a new Ezsignfolder

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

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_create_object_v2_request import EzsignfolderCreateObjectV2Request
from eZmaxApi.models.ezsignfolder_create_object_v2_response import EzsignfolderCreateObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    ezsignfolder_create_object_v2_request = eZmaxApi.EzsignfolderCreateObjectV2Request() # EzsignfolderCreateObjectV2Request | 

    try:
        # Create a new Ezsignfolder
        api_response = api_instance.ezsignfolder_create_object_v2(ezsignfolder_create_object_v2_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_create_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_create_object_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
ezsignfolder_create_object_v2_request	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]

ezsignfolder_delete_object_v1

EzsignfolderDeleteObjectV1Response ezsignfolder_delete_object_v1(pki_ezsignfolder_id)

Delete an existing Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_delete_object_v1_response import EzsignfolderDeleteObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Delete an existing Ezsignfolder
        api_response = api_instance.ezsignfolder_delete_object_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_delete_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_dispose_ezsignfolders_v1

EzsignfolderDisposeEzsignfoldersV1Response ezsignfolder_dispose_ezsignfolders_v1(ezsignfolder_dispose_ezsignfolders_v1_request)

Dispose Ezsignfolders

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_dispose_ezsignfolders_v1_request import EzsignfolderDisposeEzsignfoldersV1Request
from eZmaxApi.models.ezsignfolder_dispose_ezsignfolders_v1_response import EzsignfolderDisposeEzsignfoldersV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    ezsignfolder_dispose_ezsignfolders_v1_request = eZmaxApi.EzsignfolderDisposeEzsignfoldersV1Request() # EzsignfolderDisposeEzsignfoldersV1Request | 

    try:
        # Dispose Ezsignfolders
        api_response = api_instance.ezsignfolder_dispose_ezsignfolders_v1(ezsignfolder_dispose_ezsignfolders_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_dispose_ezsignfolders_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_dispose_ezsignfolders_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
ezsignfolder_dispose_ezsignfolders_v1_request	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]

ezsignfolder_dispose_v1

EzsignfolderDisposeV1Response ezsignfolder_dispose_v1(pki_ezsignfolder_id, body)

Dispose the Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_dispose_v1_response import EzsignfolderDisposeV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    body = None # object | 

    try:
        # Dispose the Ezsignfolder
        api_response = api_instance.ezsignfolder_dispose_v1(pki_ezsignfolder_id, body)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_dispose_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_dispose_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_edit_object_v1

EzsignfolderEditObjectV1Response ezsignfolder_edit_object_v1(pki_ezsignfolder_id, ezsignfolder_edit_object_v1_request)

Edit an existing Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_edit_object_v1_request import EzsignfolderEditObjectV1Request
from eZmaxApi.models.ezsignfolder_edit_object_v1_response import EzsignfolderEditObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_edit_object_v1_request = eZmaxApi.EzsignfolderEditObjectV1Request() # EzsignfolderEditObjectV1Request | 

    try:
        # Edit an existing Ezsignfolder
        api_response = api_instance.ezsignfolder_edit_object_v1(pki_ezsignfolder_id, ezsignfolder_edit_object_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_edit_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_edit_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_edit_object_v1_request	EzsignfolderEditObjectV1Request

Return type

EzsignfolderEditObjectV1Response

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]

ezsignfolder_end_prematurely_v1

EzsignfolderEndPrematurelyV1Response ezsignfolder_end_prematurely_v1(pki_ezsignfolder_id, body)

End prematurely

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

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_end_prematurely_v1_response import EzsignfolderEndPrematurelyV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    body = None # object | 

    try:
        # End prematurely
        api_response = api_instance.ezsignfolder_end_prematurely_v1(pki_ezsignfolder_id, body)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_end_prematurely_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_end_prematurely_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_actionable_elements_v1

EzsignfolderGetActionableElementsV1Response ezsignfolder_get_actionable_elements_v1(pki_ezsignfolder_id)

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

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response import EzsignfolderGetActionableElementsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve actionable elements for the Ezsignfolder
        api_response = api_instance.ezsignfolder_get_actionable_elements_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_actionable_elements_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_actionable_elements_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_attachment_count_v1

EzsignfolderGetAttachmentCountV1Response ezsignfolder_get_attachment_count_v1(pki_ezsignfolder_id)

Retrieve Attachment count

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve Attachment count
        api_response = api_instance.ezsignfolder_get_attachment_count_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_attachment_count_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_attachment_count_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_attachments_v1

EzsignfolderGetAttachmentsV1Response ezsignfolder_get_attachments_v1(pki_ezsignfolder_id)

Retrieve Ezsignfolder's Attachments

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve Ezsignfolder's Attachments
        api_response = api_instance.ezsignfolder_get_attachments_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_attachments_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_attachments_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_communication_count_v1

EzsignfolderGetCommunicationCountV1Response ezsignfolder_get_communication_count_v1(pki_ezsignfolder_id)

Retrieve Communication count

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response import EzsignfolderGetCommunicationCountV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve Communication count
        api_response = api_instance.ezsignfolder_get_communication_count_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_communication_count_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_communication_count_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_communication_list_v1

EzsignfolderGetCommunicationListV1Response ezsignfolder_get_communication_list_v1(pki_ezsignfolder_id)

Retrieve Communication list

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response import EzsignfolderGetCommunicationListV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve Communication list
        api_response = api_instance.ezsignfolder_get_communication_list_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_communication_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_communication_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_communicationrecipients_v1

EzsignfolderGetCommunicationrecipientsV1Response ezsignfolder_get_communicationrecipients_v1(pki_ezsignfolder_id)

Retrieve Ezsignfolder's Communicationrecipient

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response import EzsignfolderGetCommunicationrecipientsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve Ezsignfolder's Communicationrecipient
        api_response = api_instance.ezsignfolder_get_communicationrecipients_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_communicationrecipients_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_communicationrecipients_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_communicationsenders_v1

EzsignfolderGetCommunicationsendersV1Response ezsignfolder_get_communicationsenders_v1(pki_ezsignfolder_id)

Retrieve Ezsignfolder's Communicationsender

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_communicationsenders_v1_response import EzsignfolderGetCommunicationsendersV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve Ezsignfolder's Communicationsender
        api_response = api_instance.ezsignfolder_get_communicationsenders_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_communicationsenders_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_communicationsenders_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_ezsigndocuments_v1

EzsignfolderGetEzsigndocumentsV1Response ezsignfolder_get_ezsigndocuments_v1(pki_ezsignfolder_id)

Retrieve an existing Ezsignfolder's Ezsigndocuments

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_ezsigndocuments_v1_response import EzsignfolderGetEzsigndocumentsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignfolder's Ezsigndocuments
        api_response = api_instance.ezsignfolder_get_ezsigndocuments_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_ezsigndocuments_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_ezsigndocuments_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_ezsignfoldersignerassociations_v1

EzsignfolderGetEzsignfoldersignerassociationsV1Response ezsignfolder_get_ezsignfoldersignerassociations_v1(pki_ezsignfolder_id)

Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_ezsignfoldersignerassociations_v1_response import EzsignfolderGetEzsignfoldersignerassociationsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
        api_response = api_instance.ezsignfolder_get_ezsignfoldersignerassociations_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_ezsignfoldersignerassociations_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_ezsignfoldersignerassociations_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_ezsignsignatures_automatic_v1

EzsignfolderGetEzsignsignaturesAutomaticV1Response ezsignfolder_get_ezsignsignatures_automatic_v1(pki_ezsignfolder_id)

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

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_ezsignsignatures_automatic_v1_response import EzsignfolderGetEzsignsignaturesAutomaticV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
        api_response = api_instance.ezsignfolder_get_ezsignsignatures_automatic_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_ezsignsignatures_automatic_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_ezsignsignatures_automatic_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_forms_data_v1

EzsignfolderGetFormsDataV1Response ezsignfolder_get_forms_data_v1(pki_ezsignfolder_id)

Retrieve an existing Ezsignfolder's forms data

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_forms_data_v1_response import EzsignfolderGetFormsDataV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignfolder's forms data
        api_response = api_instance.ezsignfolder_get_forms_data_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_forms_data_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_forms_data_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_list_v1

EzsignfolderGetListV1Response ezsignfolder_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)

Retrieve Ezsignfolder list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter sFilter: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName |

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_list_v1_response import EzsignfolderGetListV1Response
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Ezsignfolder list
        api_response = api_instance.ezsignfolder_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
e_order_by	str	Specify how you want the results to be sorted	[optional]
i_row_max	int		[optional]
i_row_offset	int		[optional] [default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	str		[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]

ezsignfolder_get_object_v1

EzsignfolderGetObjectV1Response ezsignfolder_get_object_v1(pki_ezsignfolder_id)

Retrieve an existing Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_object_v1_response import EzsignfolderGetObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignfolder
        api_response = api_instance.ezsignfolder_get_object_v1(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_get_object_v2

EzsignfolderGetObjectV2Response ezsignfolder_get_object_v2(pki_ezsignfolder_id)

Retrieve an existing Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_get_object_v2_response import EzsignfolderGetObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 

    try:
        # Retrieve an existing Ezsignfolder
        api_response = api_instance.ezsignfolder_get_object_v2(pki_ezsignfolder_id)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_object_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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]

ezsignfolder_import_ezsignfoldersignerassociations_v1

EzsignfolderImportEzsignfoldersignerassociationsV1Response ezsignfolder_import_ezsignfoldersignerassociations_v1(pki_ezsignfolder_id, ezsignfolder_import_ezsignfoldersignerassociations_v1_request)

Import an existing Ezsignfoldersignerassociation into this Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_request import EzsignfolderImportEzsignfoldersignerassociationsV1Request
from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_response import EzsignfolderImportEzsignfoldersignerassociationsV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_import_ezsignfoldersignerassociations_v1_request = eZmaxApi.EzsignfolderImportEzsignfoldersignerassociationsV1Request() # EzsignfolderImportEzsignfoldersignerassociationsV1Request | 

    try:
        # Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
        api_response = api_instance.ezsignfolder_import_ezsignfoldersignerassociations_v1(pki_ezsignfolder_id, ezsignfolder_import_ezsignfoldersignerassociations_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_import_ezsignfoldersignerassociations_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_import_ezsignfoldersignerassociations_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_import_ezsignfoldersignerassociations_v1_request	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]

ezsignfolder_import_ezsigntemplatepackage_v1

EzsignfolderImportEzsigntemplatepackageV1Response ezsignfolder_import_ezsigntemplatepackage_v1(pki_ezsignfolder_id, ezsignfolder_import_ezsigntemplatepackage_v1_request)

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

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_request import EzsignfolderImportEzsigntemplatepackageV1Request
from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_response import EzsignfolderImportEzsigntemplatepackageV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_import_ezsigntemplatepackage_v1_request = eZmaxApi.EzsignfolderImportEzsigntemplatepackageV1Request() # EzsignfolderImportEzsigntemplatepackageV1Request | 

    try:
        # Import an Ezsigntemplatepackage in the Ezsignfolder.
        api_response = api_instance.ezsignfolder_import_ezsigntemplatepackage_v1(pki_ezsignfolder_id, ezsignfolder_import_ezsigntemplatepackage_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_import_ezsigntemplatepackage_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_import_ezsigntemplatepackage_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_import_ezsigntemplatepackage_v1_request	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]

ezsignfolder_reorder_v1

EzsignfolderReorderV1Response ezsignfolder_reorder_v1(pki_ezsignfolder_id, ezsignfolder_reorder_v1_request)

Reorder Ezsigndocuments in the Ezsignfolder

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_reorder_v1_request import EzsignfolderReorderV1Request
from eZmaxApi.models.ezsignfolder_reorder_v1_response import EzsignfolderReorderV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_reorder_v1_request = eZmaxApi.EzsignfolderReorderV1Request() # EzsignfolderReorderV1Request | 

    try:
        # Reorder Ezsigndocuments in the Ezsignfolder
        api_response = api_instance.ezsignfolder_reorder_v1(pki_ezsignfolder_id, ezsignfolder_reorder_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_reorder_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_reorder_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_reorder_v1_request	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]

ezsignfolder_send_v1

EzsignfolderSendV1Response ezsignfolder_send_v1(pki_ezsignfolder_id, ezsignfolder_send_v1_request)

Send the Ezsignfolder to the signatories for signature

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_send_v1_request import EzsignfolderSendV1Request
from eZmaxApi.models.ezsignfolder_send_v1_response import EzsignfolderSendV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_send_v1_request = eZmaxApi.EzsignfolderSendV1Request() # EzsignfolderSendV1Request | 

    try:
        # Send the Ezsignfolder to the signatories for signature
        api_response = api_instance.ezsignfolder_send_v1(pki_ezsignfolder_id, ezsignfolder_send_v1_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_send_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_send_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_send_v1_request	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]

ezsignfolder_send_v3

EzsignfolderSendV3Response ezsignfolder_send_v3(pki_ezsignfolder_id, ezsignfolder_send_v3_request)

Send the Ezsignfolder to the signatories for signature

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_send_v3_request import EzsignfolderSendV3Request
from eZmaxApi.models.ezsignfolder_send_v3_response import EzsignfolderSendV3Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    ezsignfolder_send_v3_request = eZmaxApi.EzsignfolderSendV3Request() # EzsignfolderSendV3Request | 

    try:
        # Send the Ezsignfolder to the signatories for signature
        api_response = api_instance.ezsignfolder_send_v3(pki_ezsignfolder_id, ezsignfolder_send_v3_request)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_send_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_send_v3: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	int
ezsignfolder_send_v3_request	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]

ezsignfolder_unsend_v1

EzsignfolderUnsendV1Response ezsignfolder_unsend_v1(pki_ezsignfolder_id, 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

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.ezsignfolder_unsend_v1_response import EzsignfolderUnsendV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client)
    pki_ezsignfolder_id = 56 # int | 
    body = None # object | 

    try:
        # Unsend the Ezsignfolder
        api_response = api_instance.ezsignfolder_unsend_v1(pki_ezsignfolder_id, body)
        print("The response of ObjectEzsignfolderApi->ezsignfolder_unsend_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_unsend_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_ezsignfolder_id	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.ObjectEzsignfolderApi

ezsignfolder_archive_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_batch_download_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_create_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_create_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_delete_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_dispose_ezsignfolders_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_dispose_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_edit_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_end_prematurely_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_get_actionable_elements_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ezsignfolder_get_attachment_count_v1

Example

Parameters