Skip to content

ObjectInscriptionApi.md

Latest commit

 

History

History
675 lines (455 loc) · 25.8 KB

ObjectInscriptionApi.md

File metadata and controls

675 lines (455 loc) · 25.8 KB

eZmaxApi.ObjectInscriptionApi

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

Method HTTP request Description
inscription_get_attachments_v1 GET /1/object/inscription/{pkiInscriptionID}/getAttachments Retrieve Inscription's Attachments
inscription_get_communication_count_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationCount Retrieve Communication count
inscription_get_communication_list_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
inscription_get_communicationrecipients_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationrecipients Retrieve Inscription's Communicationrecipient
inscription_get_communicationsenders_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders Retrieve Inscription's Communicationsender
inscription_get_list_v1 GET /1/object/inscription/getList Retrieve Inscription list
inscription_import_into_edmv1 POST /1/object/inscription/{pkiInscriptionID}/importIntoEDM Import attachments into the Inscription
inscription_prepare_files_transfer_v1 POST /1/object/inscription/{pkiInscriptionID}/prepareFilesTransfer Prepares file transfer into EDM

inscription_get_attachments_v1

InscriptionGetAttachmentsV1Response inscription_get_attachments_v1(pki_inscription_id)

Retrieve Inscription's Attachments

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 

    try:
        # Retrieve Inscription's Attachments
        api_response = api_instance.inscription_get_attachments_v1(pki_inscription_id)
        print("The response of ObjectInscriptionApi->inscription_get_attachments_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectInscriptionApi->inscription_get_attachments_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetAttachmentsV1Response

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]

inscription_get_communication_count_v1

InscriptionGetCommunicationCountV1Response inscription_get_communication_count_v1(pki_inscription_id)

Retrieve Communication count

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_get_communication_count_v1_response import InscriptionGetCommunicationCountV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 

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

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetCommunicationCountV1Response

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]

inscription_get_communication_list_v1

InscriptionGetCommunicationListV1Response inscription_get_communication_list_v1(pki_inscription_id)

Retrieve Communication list

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_get_communication_list_v1_response import InscriptionGetCommunicationListV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 

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

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetCommunicationListV1Response

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]

inscription_get_communicationrecipients_v1

InscriptionGetCommunicationrecipientsV1Response inscription_get_communicationrecipients_v1(pki_inscription_id)

Retrieve Inscription's Communicationrecipient

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_get_communicationrecipients_v1_response import InscriptionGetCommunicationrecipientsV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 

    try:
        # Retrieve Inscription's Communicationrecipient
        api_response = api_instance.inscription_get_communicationrecipients_v1(pki_inscription_id)
        print("The response of ObjectInscriptionApi->inscription_get_communicationrecipients_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectInscriptionApi->inscription_get_communicationrecipients_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetCommunicationrecipientsV1Response

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]

inscription_get_communicationsenders_v1

InscriptionGetCommunicationsendersV1Response inscription_get_communicationsenders_v1(pki_inscription_id)

Retrieve Inscription's Communicationsender

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 

    try:
        # Retrieve Inscription's Communicationsender
        api_response = api_instance.inscription_get_communicationsenders_v1(pki_inscription_id)
        print("The response of ObjectInscriptionApi->inscription_get_communicationsenders_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectInscriptionApi->inscription_get_communicationsenders_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetCommunicationsendersV1Response

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]

inscription_get_list_v1

InscriptionGetListV1Response inscription_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 Inscription list

Enum values that can be filtered in query parameter sFilter:

Variable Valid values
eInscriptionStep TemporaryNotAuthenticated
ImportedInscription
Inscription
ModifiedInscription
ContractEnded
ExpiredInscription
Out-market
ImportedNotauthenticated
NotAuthenticated
ModifiedNotauthenticated
Authenticated

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.models.inscription_get_list_v1_response import InscriptionGetListV1Response
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.ObjectInscriptionApi(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 Inscription list
        api_response = api_instance.inscription_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 ObjectInscriptionApi->inscription_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectInscriptionApi->inscription_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

InscriptionGetListV1Response

Authorization

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]

inscription_import_into_edmv1

InscriptionImportIntoEDMV1Response inscription_import_into_edmv1(pki_inscription_id, inscription_import_into_edmv1_request)

Import attachments into the Inscription

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_import_into_edmv1_request import InscriptionImportIntoEDMV1Request
from eZmaxApi.models.inscription_import_into_edmv1_response import InscriptionImportIntoEDMV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 
    inscription_import_into_edmv1_request = eZmaxApi.InscriptionImportIntoEDMV1Request() # InscriptionImportIntoEDMV1Request | 

    try:
        # Import attachments into the Inscription
        api_response = api_instance.inscription_import_into_edmv1(pki_inscription_id, inscription_import_into_edmv1_request)
        print("The response of ObjectInscriptionApi->inscription_import_into_edmv1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectInscriptionApi->inscription_import_into_edmv1: %s\n" % e)

Parameters

Name Type Description Notes
pki_inscription_id int
inscription_import_into_edmv1_request InscriptionImportIntoEDMV1Request

Return type

InscriptionImportIntoEDMV1Response

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 -

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

inscription_prepare_files_transfer_v1

InscriptionPrepareFilesTransferV1Response inscription_prepare_files_transfer_v1(pki_inscription_id, inscription_prepare_files_transfer_v1_request)

Prepares file transfer into EDM

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.inscription_prepare_files_transfer_v1_request import InscriptionPrepareFilesTransferV1Request
from eZmaxApi.models.inscription_prepare_files_transfer_v1_response import InscriptionPrepareFilesTransferV1Response
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.ObjectInscriptionApi(api_client)
    pki_inscription_id = 56 # int | 
    inscription_prepare_files_transfer_v1_request = eZmaxApi.InscriptionPrepareFilesTransferV1Request() # InscriptionPrepareFilesTransferV1Request | 

    try:
        # Prepares file transfer into EDM
        api_response = api_instance.inscription_prepare_files_transfer_v1(pki_inscription_id, inscription_prepare_files_transfer_v1_request)
        print("The response of ObjectInscriptionApi->inscription_prepare_files_transfer_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectInscriptionApi->inscription_prepare_files_transfer_v1: %s\n" % e)

Parameters

Name Type Description Notes
pki_inscription_id int
inscription_prepare_files_transfer_v1_request InscriptionPrepareFilesTransferV1Request

Return type

InscriptionPrepareFilesTransferV1Response

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 -

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