Skip to content

Latest commit

 

History

History
295 lines (204 loc) · 10.6 KB

ObjectElectronicfundstransferApi.md

File metadata and controls

295 lines (204 loc) · 10.6 KB

EzmaxApi::ObjectElectronicfundstransferApi

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

Method HTTP request Description
electronicfundstransfer_get_communication_count_v1 GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationCount Retrieve Communication count
electronicfundstransfer_get_communication_list_v1 GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList Retrieve Communication list
electronicfundstransfer_get_communicationrecipients_v1 GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationrecipients Retrieve Electronicfundstransfer's Communicationrecipient
electronicfundstransfer_get_communicationsenders_v1 GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationsenders Retrieve Electronicfundstransfer's Communicationsender

electronicfundstransfer_get_communication_count_v1

electronicfundstransfer_get_communication_count_v1(pki_electronicfundstransfer_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::ObjectElectronicfundstransferApi.new
pki_electronicfundstransfer_id = 56 # Integer | 

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

Using the electronicfundstransfer_get_communication_count_v1_with_http_info variant

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

<Array(, Integer, Hash)> electronicfundstransfer_get_communication_count_v1_with_http_info(pki_electronicfundstransfer_id)

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

Parameters

Name Type Description Notes
pki_electronicfundstransfer_id Integer

Return type

ElectronicfundstransferGetCommunicationCountV1Response

Authorization

Authorization

HTTP request headers

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

electronicfundstransfer_get_communication_list_v1

electronicfundstransfer_get_communication_list_v1(pki_electronicfundstransfer_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::ObjectElectronicfundstransferApi.new
pki_electronicfundstransfer_id = 56 # Integer | 

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

Using the electronicfundstransfer_get_communication_list_v1_with_http_info variant

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

<Array(, Integer, Hash)> electronicfundstransfer_get_communication_list_v1_with_http_info(pki_electronicfundstransfer_id)

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

Parameters

Name Type Description Notes
pki_electronicfundstransfer_id Integer

Return type

ElectronicfundstransferGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

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

electronicfundstransfer_get_communicationrecipients_v1

electronicfundstransfer_get_communicationrecipients_v1(pki_electronicfundstransfer_id)

Retrieve Electronicfundstransfer'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::ObjectElectronicfundstransferApi.new
pki_electronicfundstransfer_id = 56 # Integer | 

begin
  # Retrieve Electronicfundstransfer's Communicationrecipient
  result = api_instance.electronicfundstransfer_get_communicationrecipients_v1(pki_electronicfundstransfer_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectElectronicfundstransferApi->electronicfundstransfer_get_communicationrecipients_v1: #{e}"
end

Using the electronicfundstransfer_get_communicationrecipients_v1_with_http_info variant

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

<Array(, Integer, Hash)> electronicfundstransfer_get_communicationrecipients_v1_with_http_info(pki_electronicfundstransfer_id)

begin
  # Retrieve Electronicfundstransfer's Communicationrecipient
  data, status_code, headers = api_instance.electronicfundstransfer_get_communicationrecipients_v1_with_http_info(pki_electronicfundstransfer_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ElectronicfundstransferGetCommunicationrecipientsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectElectronicfundstransferApi->electronicfundstransfer_get_communicationrecipients_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_electronicfundstransfer_id Integer

Return type

ElectronicfundstransferGetCommunicationrecipientsV1Response

Authorization

Authorization

HTTP request headers

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

electronicfundstransfer_get_communicationsenders_v1

electronicfundstransfer_get_communicationsenders_v1(pki_electronicfundstransfer_id)

Retrieve Electronicfundstransfer'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::ObjectElectronicfundstransferApi.new
pki_electronicfundstransfer_id = 56 # Integer | 

begin
  # Retrieve Electronicfundstransfer's Communicationsender
  result = api_instance.electronicfundstransfer_get_communicationsenders_v1(pki_electronicfundstransfer_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectElectronicfundstransferApi->electronicfundstransfer_get_communicationsenders_v1: #{e}"
end

Using the electronicfundstransfer_get_communicationsenders_v1_with_http_info variant

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

<Array(, Integer, Hash)> electronicfundstransfer_get_communicationsenders_v1_with_http_info(pki_electronicfundstransfer_id)

begin
  # Retrieve Electronicfundstransfer's Communicationsender
  data, status_code, headers = api_instance.electronicfundstransfer_get_communicationsenders_v1_with_http_info(pki_electronicfundstransfer_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ElectronicfundstransferGetCommunicationsendersV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectElectronicfundstransferApi->electronicfundstransfer_get_communicationsenders_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_electronicfundstransfer_id Integer

Return type

ElectronicfundstransferGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

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