Skip to content

ObjectBillingentityexternalApi.md

Latest commit

 

History

History
161 lines (115 loc) · 6.35 KB

ObjectBillingentityexternalApi.md

File metadata and controls

161 lines (115 loc) · 6.35 KB

EzmaxApi::ObjectBillingentityexternalApi

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

Method HTTP request Description
billingentityexternal_generate_federation_token_v1 POST /1/object/billingentityexternal/{pkiBillingentityexternalID}/generateFederationToken Generate a federation token
billingentityexternal_get_autocomplete_v2 GET /2/object/billingentityexternal/getAutocomplete/{sSelector} Retrieve Billingentityexternals and IDs

billingentityexternal_generate_federation_token_v1

billingentityexternal_generate_federation_token_v1(pki_billingentityexternal_id, billingentityexternal_generate_federation_token_v1_request)

Generate a federation token

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::ObjectBillingentityexternalApi.new
pki_billingentityexternal_id = 56 # Integer | 
billingentityexternal_generate_federation_token_v1_request = EzmaxApi::BillingentityexternalGenerateFederationTokenV1Request.new({fks_ezmaxcustomer_code: 'demo'}) # BillingentityexternalGenerateFederationTokenV1Request | 

begin
  # Generate a federation token
  result = api_instance.billingentityexternal_generate_federation_token_v1(pki_billingentityexternal_id, billingentityexternal_generate_federation_token_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectBillingentityexternalApi->billingentityexternal_generate_federation_token_v1: #{e}"
end

Using the billingentityexternal_generate_federation_token_v1_with_http_info variant

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

<Array(, Integer, Hash)> billingentityexternal_generate_federation_token_v1_with_http_info(pki_billingentityexternal_id, billingentityexternal_generate_federation_token_v1_request)

begin
  # Generate a federation token
  data, status_code, headers = api_instance.billingentityexternal_generate_federation_token_v1_with_http_info(pki_billingentityexternal_id, billingentityexternal_generate_federation_token_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <BillingentityexternalGenerateFederationTokenV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectBillingentityexternalApi->billingentityexternal_generate_federation_token_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_billingentityexternal_id Integer
billingentityexternal_generate_federation_token_v1_request BillingentityexternalGenerateFederationTokenV1Request

Return type

BillingentityexternalGenerateFederationTokenV1Response

Authorization

Authorization

HTTP request headers

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

billingentityexternal_get_autocomplete_v2

billingentityexternal_get_autocomplete_v2(s_selector, opts)

Retrieve Billingentityexternals and IDs

Get the list of Billingentityexternal to be used in a dropdown or autocomplete control.

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::ObjectBillingentityexternalApi.new
s_selector = 'All' # String | The type of Billingentityexternals to return
opts = {
  e_filter_active: 'All', # String | Specify which results we want to display.
  s_query: 's_query_example', # String | Allow to filter the returned results
  accept_language: EzmaxApi::HeaderAcceptLanguage:: # HeaderAcceptLanguage | 
}

begin
  # Retrieve Billingentityexternals and IDs
  result = api_instance.billingentityexternal_get_autocomplete_v2(s_selector, opts)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectBillingentityexternalApi->billingentityexternal_get_autocomplete_v2: #{e}"
end

Using the billingentityexternal_get_autocomplete_v2_with_http_info variant

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

<Array(, Integer, Hash)> billingentityexternal_get_autocomplete_v2_with_http_info(s_selector, opts)

begin
  # Retrieve Billingentityexternals and IDs
  data, status_code, headers = api_instance.billingentityexternal_get_autocomplete_v2_with_http_info(s_selector, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <BillingentityexternalGetAutocompleteV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectBillingentityexternalApi->billingentityexternal_get_autocomplete_v2_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
s_selector String The type of Billingentityexternals to return
e_filter_active String Specify which results we want to display. [optional][default to 'Active']
s_query String Allow to filter the returned results [optional]
accept_language HeaderAcceptLanguage [optional]

Return type

BillingentityexternalGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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