Skip to content

Latest commit

 

History

History
169 lines (113 loc) · 5.24 KB

ObjectInscriptionApi.md

File metadata and controls

169 lines (113 loc) · 5.24 KB

EzmaxApi::ObjectInscriptionApi

Load the API package

use EzmaxApi::Object::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_list_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
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 => $pki_inscription_id)

Retrieve Inscription's Attachments

Example

use Data::Dumper;
use EzmaxApi::ObjectInscriptionApi;
my $api_instance = EzmaxApi::ObjectInscriptionApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_inscription_id = 56; # int | 

eval {
    my $result = $api_instance->inscription_get_attachments_v1(pki_inscription_id => $pki_inscription_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectInscriptionApi->inscription_get_attachments_v1: $@\n";
}

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetAttachmentsV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[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 => $pki_inscription_id)

Retrieve Communication list

Example

use Data::Dumper;
use EzmaxApi::ObjectInscriptionApi;
my $api_instance = EzmaxApi::ObjectInscriptionApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_inscription_id = 56; # int | 

eval {
    my $result = $api_instance->inscription_get_communication_list_v1(pki_inscription_id => $pki_inscription_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectInscriptionApi->inscription_get_communication_list_v1: $@\n";
}

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[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 => $pki_inscription_id)

Retrieve Inscription's Communicationsender

Example

use Data::Dumper;
use EzmaxApi::ObjectInscriptionApi;
my $api_instance = EzmaxApi::ObjectInscriptionApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $pki_inscription_id = 56; # int | 

eval {
    my $result = $api_instance->inscription_get_communicationsenders_v1(pki_inscription_id => $pki_inscription_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectInscriptionApi->inscription_get_communicationsenders_v1: $@\n";
}

Parameters

Name Type Description Notes
pki_inscription_id int

Return type

InscriptionGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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