Method: NucleusApi::RoundupApi#get_roundup_settings_using_get_with_http_info

Defined in:
lib/nucleus_api/api/roundup_api.rb

#get_roundup_settings_using_get_with_http_info(roundup_setting_id, opts = {}) ⇒ Array<(RoundupSettings, Fixnum, Hash)>

Retrieve a Roundup Setting Retrieve the information for a Roundup Settings with your firm.

Parameters:

  • roundup_setting_id

    UUID roundup_setting_id

  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(RoundupSettings, Fixnum, Hash)>)

    RoundupSettings data, response status code and response headers



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/nucleus_api/api/roundup_api.rb', line 318

def get_roundup_settings_using_get_with_http_info(roundup_setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoundupApi.get_roundup_settings_using_get ...'
  end
  # verify the required parameter 'roundup_setting_id' is set
  if @api_client.config.client_side_validation && roundup_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'roundup_setting_id' when calling RoundupApi.get_roundup_settings_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/roundup_setting/{roundup_setting_id}'.sub('{' + 'roundup_setting_id' + '}', roundup_setting_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoundupSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoundupApi#get_roundup_settings_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end