Skip to content

ObjectTranqcontractApi.md

Latest commit

 

History

History
369 lines (256 loc) · 12.3 KB

ObjectTranqcontractApi.md

File metadata and controls

369 lines (256 loc) · 12.3 KB

EzmaxApi::ObjectTranqcontractApi

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

Method HTTP request Description
tranqcontract_get_communication_count_v1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationCount Retrieve Communication count
tranqcontract_get_communication_list_v1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationList Retrieve Communication list
tranqcontract_get_communicationrecipients_v1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationrecipients Retrieve Tranqcontract's Communicationrecipient
tranqcontract_get_communicationsenders_v1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationsenders Retrieve Tranqcontract's Communicationsender
tranqcontract_import_into_edmv1 POST /1/object/tranqcontract/{pkiTranqcontractID}/importIntoEDM Import attachments into the Tranqcontract

tranqcontract_get_communication_count_v1

tranqcontract_get_communication_count_v1(pki_tranqcontract_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::ObjectTranqcontractApi.new
pki_tranqcontract_id = 56 # Integer | 

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

Using the tranqcontract_get_communication_count_v1_with_http_info variant

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

<Array(, Integer, Hash)> tranqcontract_get_communication_count_v1_with_http_info(pki_tranqcontract_id)

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

Parameters

Name Type Description Notes
pki_tranqcontract_id Integer

Return type

TranqcontractGetCommunicationCountV1Response

Authorization

Authorization

HTTP request headers

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

tranqcontract_get_communication_list_v1

tranqcontract_get_communication_list_v1(pki_tranqcontract_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::ObjectTranqcontractApi.new
pki_tranqcontract_id = 56 # Integer | 

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

Using the tranqcontract_get_communication_list_v1_with_http_info variant

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

<Array(, Integer, Hash)> tranqcontract_get_communication_list_v1_with_http_info(pki_tranqcontract_id)

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

Parameters

Name Type Description Notes
pki_tranqcontract_id Integer

Return type

TranqcontractGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

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

tranqcontract_get_communicationrecipients_v1

tranqcontract_get_communicationrecipients_v1(pki_tranqcontract_id)

Retrieve Tranqcontract'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::ObjectTranqcontractApi.new
pki_tranqcontract_id = 56 # Integer | 

begin
  # Retrieve Tranqcontract's Communicationrecipient
  result = api_instance.tranqcontract_get_communicationrecipients_v1(pki_tranqcontract_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectTranqcontractApi->tranqcontract_get_communicationrecipients_v1: #{e}"
end

Using the tranqcontract_get_communicationrecipients_v1_with_http_info variant

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

<Array(, Integer, Hash)> tranqcontract_get_communicationrecipients_v1_with_http_info(pki_tranqcontract_id)

begin
  # Retrieve Tranqcontract's Communicationrecipient
  data, status_code, headers = api_instance.tranqcontract_get_communicationrecipients_v1_with_http_info(pki_tranqcontract_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TranqcontractGetCommunicationrecipientsV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectTranqcontractApi->tranqcontract_get_communicationrecipients_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_tranqcontract_id Integer

Return type

TranqcontractGetCommunicationrecipientsV1Response

Authorization

Authorization

HTTP request headers

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

tranqcontract_get_communicationsenders_v1

tranqcontract_get_communicationsenders_v1(pki_tranqcontract_id)

Retrieve Tranqcontract'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::ObjectTranqcontractApi.new
pki_tranqcontract_id = 56 # Integer | 

begin
  # Retrieve Tranqcontract's Communicationsender
  result = api_instance.tranqcontract_get_communicationsenders_v1(pki_tranqcontract_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectTranqcontractApi->tranqcontract_get_communicationsenders_v1: #{e}"
end

Using the tranqcontract_get_communicationsenders_v1_with_http_info variant

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

<Array(, Integer, Hash)> tranqcontract_get_communicationsenders_v1_with_http_info(pki_tranqcontract_id)

begin
  # Retrieve Tranqcontract's Communicationsender
  data, status_code, headers = api_instance.tranqcontract_get_communicationsenders_v1_with_http_info(pki_tranqcontract_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TranqcontractGetCommunicationsendersV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectTranqcontractApi->tranqcontract_get_communicationsenders_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_tranqcontract_id Integer

Return type

TranqcontractGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

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

tranqcontract_import_into_edmv1

tranqcontract_import_into_edmv1(pki_tranqcontract_id, tranqcontract_import_into_edmv1_request)

Import attachments into the Tranqcontract

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::ObjectTranqcontractApi.new
pki_tranqcontract_id = 56 # Integer | 
tranqcontract_import_into_edmv1_request = EzmaxApi::TranqcontractImportIntoEDMV1Request.new({a_obj_attachment: [EzmaxApi::CustomAttachmentImportIntoEDMRequest.new({e_attachment_source: 'Attachment', s_attachment_name: 'Document.pdf', s_attachment_category: 'Inscription', e_attachment_privacy: EzmaxApi::FieldEAttachmentPrivacy::ALL})]}) # TranqcontractImportIntoEDMV1Request | 

begin
  # Import attachments into the Tranqcontract
  result = api_instance.tranqcontract_import_into_edmv1(pki_tranqcontract_id, tranqcontract_import_into_edmv1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectTranqcontractApi->tranqcontract_import_into_edmv1: #{e}"
end

Using the tranqcontract_import_into_edmv1_with_http_info variant

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

<Array(, Integer, Hash)> tranqcontract_import_into_edmv1_with_http_info(pki_tranqcontract_id, tranqcontract_import_into_edmv1_request)

begin
  # Import attachments into the Tranqcontract
  data, status_code, headers = api_instance.tranqcontract_import_into_edmv1_with_http_info(pki_tranqcontract_id, tranqcontract_import_into_edmv1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TranqcontractImportIntoEDMV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectTranqcontractApi->tranqcontract_import_into_edmv1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_tranqcontract_id Integer
tranqcontract_import_into_edmv1_request TranqcontractImportIntoEDMV1Request

Return type

TranqcontractImportIntoEDMV1Response

Authorization

Authorization

HTTP request headers

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