Skip to content

Latest commit

 

History

History
295 lines (204 loc) · 9.23 KB

ObjectOtherincomeApi.md

File metadata and controls

295 lines (204 loc) · 9.23 KB

EzmaxApi::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

otherincome_get_communication_count_v1(pki_otherincome_id)

Retrieve Communication count

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectOtherincomeApi.new
pki_otherincome_id = 56 # Integer | 

begin
  # Retrieve Communication count
  result = api_instance.otherincome_get_communication_count_v1(pki_otherincome_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communication_count_v1: #{e}"
end

Using the otherincome_get_communication_count_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> otherincome_get_communication_count_v1_with_http_info(pki_otherincome_id)

begin
  # Retrieve Communication count
  data, status_code, headers = api_instance.otherincome_get_communication_count_v1_with_http_info(pki_otherincome_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OtherincomeGetCommunicationCountV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communication_count_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_otherincome_id Integer

Return type

OtherincomeGetCommunicationCountV1Response

Authorization

Authorization

HTTP request headers

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

otherincome_get_communication_list_v1

otherincome_get_communication_list_v1(pki_otherincome_id)

Retrieve Communication list

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectOtherincomeApi.new
pki_otherincome_id = 56 # Integer | 

begin
  # Retrieve Communication list
  result = api_instance.otherincome_get_communication_list_v1(pki_otherincome_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communication_list_v1: #{e}"
end

Using the otherincome_get_communication_list_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> otherincome_get_communication_list_v1_with_http_info(pki_otherincome_id)

begin
  # Retrieve Communication list
  data, status_code, headers = api_instance.otherincome_get_communication_list_v1_with_http_info(pki_otherincome_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OtherincomeGetCommunicationListV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communication_list_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_otherincome_id Integer

Return type

OtherincomeGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

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

otherincome_get_communicationrecipients_v1

otherincome_get_communicationrecipients_v1(pki_otherincome_id)

Retrieve Otherincome's Communicationrecipient

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectOtherincomeApi.new
pki_otherincome_id = 56 # Integer | 

begin
  # Retrieve Otherincome's Communicationrecipient
  result = api_instance.otherincome_get_communicationrecipients_v1(pki_otherincome_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communicationrecipients_v1: #{e}"
end

Using the otherincome_get_communicationrecipients_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> otherincome_get_communicationrecipients_v1_with_http_info(pki_otherincome_id)

begin
  # Retrieve Otherincome's Communicationrecipient
  data, status_code, headers = api_instance.otherincome_get_communicationrecipients_v1_with_http_info(pki_otherincome_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OtherincomeGetCommunicationrecipientsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communicationrecipients_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_otherincome_id Integer

Return type

OtherincomeGetCommunicationrecipientsV1Response

Authorization

Authorization

HTTP request headers

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

otherincome_get_communicationsenders_v1

otherincome_get_communicationsenders_v1(pki_otherincome_id)

Retrieve Otherincome's Communicationsender

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectOtherincomeApi.new
pki_otherincome_id = 56 # Integer | 

begin
  # Retrieve Otherincome's Communicationsender
  result = api_instance.otherincome_get_communicationsenders_v1(pki_otherincome_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communicationsenders_v1: #{e}"
end

Using the otherincome_get_communicationsenders_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> otherincome_get_communicationsenders_v1_with_http_info(pki_otherincome_id)

begin
  # Retrieve Otherincome's Communicationsender
  data, status_code, headers = api_instance.otherincome_get_communicationsenders_v1_with_http_info(pki_otherincome_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OtherincomeGetCommunicationsendersV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectOtherincomeApi->otherincome_get_communicationsenders_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_otherincome_id Integer

Return type

OtherincomeGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

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