ObjectActivesessionApi.md

EzmaxApi::ObjectActivesessionApi

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

Method	HTTP request	Description
activesession_get_current_v1	GET /1/object/activesession/getCurrent	Get Current Activesession
activesession_get_list_v1	GET /1/object/activesession/getList	Retrieve Activesession list

activesession_get_current_v1

activesession_get_current_v1

Get Current Activesession

Retrieve the details about the current activesession

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::ObjectActivesessionApi.new

begin
  # Get Current Activesession
  result = api_instance.activesession_get_current_v1
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectActivesessionApi->activesession_get_current_v1: #{e}"
end

Using the activesession_get_current_v1_with_http_info variant

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

<Array(, Integer, Hash)> activesession_get_current_v1_with_http_info

begin
  # Get Current Activesession
  data, status_code, headers = api_instance.activesession_get_current_v1_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ActivesessionGetCurrentV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectActivesessionApi->activesession_get_current_v1_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ActivesessionGetCurrentV1Response

Authorization

Authorization

HTTP request headers

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

activesession_get_list_v1

activesession_get_list_v1(opts)

Retrieve Activesession 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::ObjectActivesessionApi.new
opts = {
  e_order_by: 'pkiActivesessionID_ASC', # String | Specify how you want the results to be sorted
  i_row_max: 56, # Integer | 
  i_row_offset: 56, # Integer | 
  accept_language: EzmaxApi::HeaderAcceptLanguage::, # HeaderAcceptLanguage | 
  s_filter: 's_filter_example' # String | 
}

begin
  # Retrieve Activesession list
  result = api_instance.activesession_get_list_v1(opts)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectActivesessionApi->activesession_get_list_v1: #{e}"
end

Using the activesession_get_list_v1_with_http_info variant

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

<Array(, Integer, Hash)> activesession_get_list_v1_with_http_info(opts)

begin
  # Retrieve Activesession list
  data, status_code, headers = api_instance.activesession_get_list_v1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ActivesessionGetListV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectActivesessionApi->activesession_get_list_v1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
e_order_by	String	Specify how you want the results to be sorted	[optional]
i_row_max	Integer		[optional]
i_row_offset	Integer		[optional][default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	String		[optional]

Return type

ActivesessionGetListV1Response

Authorization

Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet