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_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

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

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

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

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

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]

Files

ObjectInscriptionApi.md

Latest commit

History

ObjectInscriptionApi.md

File metadata and controls

eZmaxApi.ObjectInscriptionApi

inscription_get_attachments_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscription_get_communication_count_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscription_get_communication_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscription_get_communicationrecipients_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscription_get_communicationsenders_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details