Skip to content

Latest commit

 

History

History
221 lines (148 loc) · 7.04 KB

ObjectOtherincomeApi.md

File metadata and controls

221 lines (148 loc) · 7.04 KB

EzmaxApi::ObjectOtherincomeApi

Load the API package

use EzmaxApi::Object::ObjectOtherincomeApi;

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

Method HTTP request Description
otherincome_get_communication_count_v1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationCount Retrieve Communication count
otherincome_get_communication_list_v1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList Retrieve Communication list
otherincome_get_communicationrecipients_v1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationrecipients Retrieve Otherincome's Communicationrecipient
otherincome_get_communicationsenders_v1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationsenders Retrieve Otherincome's Communicationsender

otherincome_get_communication_count_v1

OtherincomeGetCommunicationCountV1Response otherincome_get_communication_count_v1(pki_otherincome_id => $pki_otherincome_id)

Retrieve Communication count

Example

use Data::Dumper;
use EzmaxApi::ObjectOtherincomeApi;
my $api_instance = EzmaxApi::ObjectOtherincomeApi->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_otherincome_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_otherincome_id int

Return type

OtherincomeGetCommunicationCountV1Response

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]

otherincome_get_communication_list_v1

OtherincomeGetCommunicationListV1Response otherincome_get_communication_list_v1(pki_otherincome_id => $pki_otherincome_id)

Retrieve Communication list

Example

use Data::Dumper;
use EzmaxApi::ObjectOtherincomeApi;
my $api_instance = EzmaxApi::ObjectOtherincomeApi->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_otherincome_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_otherincome_id int

Return type

OtherincomeGetCommunicationListV1Response

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]

otherincome_get_communicationrecipients_v1

OtherincomeGetCommunicationrecipientsV1Response otherincome_get_communicationrecipients_v1(pki_otherincome_id => $pki_otherincome_id)

Retrieve Otherincome's Communicationrecipient

Example

use Data::Dumper;
use EzmaxApi::ObjectOtherincomeApi;
my $api_instance = EzmaxApi::ObjectOtherincomeApi->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_otherincome_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_otherincome_id int

Return type

OtherincomeGetCommunicationrecipientsV1Response

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]

otherincome_get_communicationsenders_v1

OtherincomeGetCommunicationsendersV1Response otherincome_get_communicationsenders_v1(pki_otherincome_id => $pki_otherincome_id)

Retrieve Otherincome's Communicationsender

Example

use Data::Dumper;
use EzmaxApi::ObjectOtherincomeApi;
my $api_instance = EzmaxApi::ObjectOtherincomeApi->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_otherincome_id = 56; # int | 

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

Parameters

Name Type Description Notes
pki_otherincome_id int

Return type

OtherincomeGetCommunicationsendersV1Response

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]