Skip to content

ObjectEzsigntemplatesignatureApi.md

Latest commit

 

History

History
421 lines (282 loc) · 17.2 KB

ObjectEzsigntemplatesignatureApi.md

File metadata and controls

421 lines (282 loc) · 17.2 KB

eZmaxApi.ObjectEzsigntemplatesignatureApi

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

Method HTTP request Description
ezsigntemplatesignature_create_object_v2 POST /2/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
ezsigntemplatesignature_create_object_v3 POST /3/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
ezsigntemplatesignature_delete_object_v1 DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Delete an existing Ezsigntemplatesignature
ezsigntemplatesignature_edit_object_v3 PUT /3/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Edit an existing Ezsigntemplatesignature
ezsigntemplatesignature_get_object_v4 GET /4/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Retrieve an existing Ezsigntemplatesignature

ezsigntemplatesignature_create_object_v2

EzsigntemplatesignatureCreateObjectV2Response ezsigntemplatesignature_create_object_v2(ezsigntemplatesignature_create_object_v2_request)

Create a new Ezsigntemplatesignature

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

Major step overhaul.

Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplatesignature_create_object_v2_request import EzsigntemplatesignatureCreateObjectV2Request
from eZmaxApi.models.ezsigntemplatesignature_create_object_v2_response import EzsigntemplatesignatureCreateObjectV2Response
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.ObjectEzsigntemplatesignatureApi(api_client)
    ezsigntemplatesignature_create_object_v2_request = eZmaxApi.EzsigntemplatesignatureCreateObjectV2Request() # EzsigntemplatesignatureCreateObjectV2Request | 

    try:
        # Create a new Ezsigntemplatesignature
        api_response = api_instance.ezsigntemplatesignature_create_object_v2(ezsigntemplatesignature_create_object_v2_request)
        print("The response of ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_create_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_create_object_v2: %s\n" % e)

Parameters

Name Type Description Notes
ezsigntemplatesignature_create_object_v2_request EzsigntemplatesignatureCreateObjectV2Request

Return type

EzsigntemplatesignatureCreateObjectV2Response

Authorization

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]

ezsigntemplatesignature_create_object_v3

EzsigntemplatesignatureCreateObjectV3Response ezsigntemplatesignature_create_object_v3(ezsigntemplatesignature_create_object_v3_request)

Create a new Ezsigntemplatesignature

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplatesignature_create_object_v3_request import EzsigntemplatesignatureCreateObjectV3Request
from eZmaxApi.models.ezsigntemplatesignature_create_object_v3_response import EzsigntemplatesignatureCreateObjectV3Response
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.ObjectEzsigntemplatesignatureApi(api_client)
    ezsigntemplatesignature_create_object_v3_request = eZmaxApi.EzsigntemplatesignatureCreateObjectV3Request() # EzsigntemplatesignatureCreateObjectV3Request | 

    try:
        # Create a new Ezsigntemplatesignature
        api_response = api_instance.ezsigntemplatesignature_create_object_v3(ezsigntemplatesignature_create_object_v3_request)
        print("The response of ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_create_object_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_create_object_v3: %s\n" % e)

Parameters

Name Type Description Notes
ezsigntemplatesignature_create_object_v3_request EzsigntemplatesignatureCreateObjectV3Request

Return type

EzsigntemplatesignatureCreateObjectV3Response

Authorization

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]

ezsigntemplatesignature_delete_object_v1

EzsigntemplatesignatureDeleteObjectV1Response ezsigntemplatesignature_delete_object_v1(pki_ezsigntemplatesignature_id)

Delete an existing Ezsigntemplatesignature

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplatesignature_delete_object_v1_response import EzsigntemplatesignatureDeleteObjectV1Response
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.ObjectEzsigntemplatesignatureApi(api_client)
    pki_ezsigntemplatesignature_id = 56 # int | 

    try:
        # Delete an existing Ezsigntemplatesignature
        api_response = api_instance.ezsigntemplatesignature_delete_object_v1(pki_ezsigntemplatesignature_id)
        print("The response of ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_delete_object_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsigntemplatesignature_id int

Return type

EzsigntemplatesignatureDeleteObjectV1Response

Authorization

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]

ezsigntemplatesignature_edit_object_v3

EzsigntemplatesignatureEditObjectV3Response ezsigntemplatesignature_edit_object_v3(pki_ezsigntemplatesignature_id, ezsigntemplatesignature_edit_object_v3_request)

Edit an existing Ezsigntemplatesignature

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplatesignature_edit_object_v3_request import EzsigntemplatesignatureEditObjectV3Request
from eZmaxApi.models.ezsigntemplatesignature_edit_object_v3_response import EzsigntemplatesignatureEditObjectV3Response
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.ObjectEzsigntemplatesignatureApi(api_client)
    pki_ezsigntemplatesignature_id = 56 # int | 
    ezsigntemplatesignature_edit_object_v3_request = eZmaxApi.EzsigntemplatesignatureEditObjectV3Request() # EzsigntemplatesignatureEditObjectV3Request | 

    try:
        # Edit an existing Ezsigntemplatesignature
        api_response = api_instance.ezsigntemplatesignature_edit_object_v3(pki_ezsigntemplatesignature_id, ezsigntemplatesignature_edit_object_v3_request)
        print("The response of ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_edit_object_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_edit_object_v3: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsigntemplatesignature_id int
ezsigntemplatesignature_edit_object_v3_request EzsigntemplatesignatureEditObjectV3Request

Return type

EzsigntemplatesignatureEditObjectV3Response

Authorization

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]

ezsigntemplatesignature_get_object_v4

EzsigntemplatesignatureGetObjectV4Response ezsigntemplatesignature_get_object_v4(pki_ezsigntemplatesignature_id)

Retrieve an existing Ezsigntemplatesignature

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.ezsigntemplatesignature_get_object_v4_response import EzsigntemplatesignatureGetObjectV4Response
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.ObjectEzsigntemplatesignatureApi(api_client)
    pki_ezsigntemplatesignature_id = 56 # int | 

    try:
        # Retrieve an existing Ezsigntemplatesignature
        api_response = api_instance.ezsigntemplatesignature_get_object_v4(pki_ezsigntemplatesignature_id)
        print("The response of ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_get_object_v4:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectEzsigntemplatesignatureApi->ezsigntemplatesignature_get_object_v4: %s\n" % e)

Parameters

Name Type Description Notes
pki_ezsigntemplatesignature_id int

Return type

EzsigntemplatesignatureGetObjectV4Response

Authorization

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]