Class: RusticiSoftwareCloudV2::RegistrationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/api/registration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RegistrationApi

Returns a new instance of RegistrationApi.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

Get registration launch link. Returns the link to use to launch this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 28

def build_registration_launch_link(registration_id, launch_link_request, opts = {})
  data, _status_code, _headers = build_registration_launch_link_with_http_info(registration_id, launch_link_request, opts)
  return data
end

#build_registration_launch_link_with_http_info(registration_id, launch_link_request, opts = {}) ⇒ Array<(LaunchLinkSchema, Fixnum, Hash)>

Get registration launch link. Returns the link to use to launch this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(LaunchLinkSchema, Fixnum, Hash)>) —

    LaunchLinkSchema data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 39

def build_registration_launch_link_with_http_info(registration_id, launch_link_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.build_registration_launch_link ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.build_registration_launch_link" if registration_id.nil?
  # verify the required parameter 'launch_link_request' is set
  fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.build_registration_launch_link" if launch_link_request.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/launchLink".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(launch_link_request)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LaunchLinkSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#build_registration_launch_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_new_registration_instance(registration_id, opts = {}) ⇒ nil

Create a new instance for this registration specified by the registration ID.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


84
85
86
87
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 84

def create_new_registration_instance(registration_id, opts = {})
  create_new_registration_instance_with_http_info(registration_id, opts)
  return nil
end

#create_new_registration_instance_with_http_info(registration_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a new instance for this registration specified by the registration ID.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 94

def create_new_registration_instance_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.create_new_registration_instance ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/instances".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#create_registration(registration, opts = {}) ⇒ nil

Create a registration. This method is used to create a new registration. A registration will contain a few pieces of information such as a learner name, a learner id, and optionally, information about where activity data should be posted (for client consumption), as well as a way to specify simple authentication schemes for posting said data. A registration must be tied to a specific course at creation time. When the created registration is “launched”, the course specified at creation time will be launched.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_version (Integer) —

    The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.

Returns:

  • (nil) 


137
138
139
140
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 137

def create_registration(registration, opts = {})
  create_registration_with_http_info(registration, opts)
  return nil
end

#create_registration_with_http_info(registration, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a registration. This method is used to create a new registration. A registration will contain a few pieces of information such as a learner name, a learner id, and optionally, information about where activity data should be posted (for client consumption), as well as a way to specify simple authentication schemes for posting said data. A registration must be tied to a specific course at creation time. When the created registration is “launched”, the course specified at creation time will be launched.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_version (Integer) —

    The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 148

def create_registration_with_http_info(registration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.create_registration ..."
  end
  # verify the required parameter 'registration' is set
  fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration" if registration.nil?
  # resource path
  local_var_path = "/registrations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'courseVersion'] = opts[:'course_version'] if !opts[:'course_version'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(registration)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#create_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_registration(registration_id, opts = {}) ⇒ nil

Delete a registration. Delete ‘registrationId`. This includes all instances of this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


191
192
193
194
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 191

def delete_registration(registration_id, opts = {})
  delete_registration_with_http_info(registration_id, opts)
  return nil
end

#delete_registration_configuration_setting(registration_id, setting_id, opts = {}) ⇒ nil

Clear a registration configuration. Clears the ‘settingId` value for this registration. The effective value will become the value at the next level which has an explicit value set. Possibilities are course, application, or default.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


244
245
246
247
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 244

def delete_registration_configuration_setting(registration_id, setting_id, opts = {})
  delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts)
  return nil
end

#delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Clear a registration configuration. Clears the &#x60;settingId&#x60; value for this registration. The effective value will become the value at the next level which has an explicit value set. Possibilities are course, application, or default.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 255

def delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_configuration_setting ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting" if registration_id.nil?
  # verify the required parameter 'setting_id' is set
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting" if setting_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/configuration/{settingId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'settingId' + '}', 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(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#delete_registration_global_data(registration_id, opts = {}) ⇒ nil

Delete the global data of a registration. Delete global data associated with ‘registrationId`’. Calling this method will reset all global objectives associated with this registration, if any exist.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


299
300
301
302
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 299

def delete_registration_global_data(registration_id, opts = {})
  delete_registration_global_data_with_http_info(registration_id, opts)
  return nil
end

#delete_registration_global_data_with_http_info(registration_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the global data of a registration. Delete global data associated with &#x60;registrationId&#x60;&#39;. Calling this method will reset all global objectives associated with this registration, if any exist.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



309
310
311
312
313
314
315
316
317
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
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 309

def delete_registration_global_data_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_global_data ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_global_data" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/globalData".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#delete_registration_instance_configuration_setting(registration_id, instance_id, setting_id, opts = {}) ⇒ nil

Clear a configuration for an instance of a registration. Clears the ‘settingId` value for this registration instance.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Returns:

  • (nil) 


353
354
355
356
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 353

def delete_registration_instance_configuration_setting(registration_id, instance_id, setting_id, opts = {})
  delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts)
  return nil
end

#delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Clear a configuration for an instance of a registration. Clears the &#x60;settingId&#x60; value for this registration instance.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 365

def delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_instance_configuration_setting ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting" if registration_id.nil?
  # verify the required parameter 'instance_id' is set
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting" if instance_id.nil?
  if instance_id < 0
    fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.delete_registration_instance_configuration_setting, must be greater than or equal to 0.'
  end

  # verify the required parameter 'setting_id' is set
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting" if setting_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s).sub('{' + 'settingId' + '}', 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(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#delete_registration_progress(registration_id, opts = {}) ⇒ nil

Reset a registration. This method will reset the specified registration. This is essentially the same as deleting and recreating the registration, and as such, will delete all the data associated with the registration (including launch history, etc.). If the course for which the registration is registered has multiple versions, the registration being reset will automatically be registered for the latest version.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


415
416
417
418
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 415

def delete_registration_progress(registration_id, opts = {})
  delete_registration_progress_with_http_info(registration_id, opts)
  return nil
end

#delete_registration_progress_with_http_info(registration_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Reset a registration. This method will reset the specified registration. This is essentially the same as deleting and recreating the registration, and as such, will delete all the data associated with the registration (including launch history, etc.). If the course for which the registration is registered has multiple versions, the registration being reset will automatically be registered for the latest version.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 425

def delete_registration_progress_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_progress ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/progress".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#delete_registration_tags(registration_id, tags, opts = {}) ⇒ nil

Delete tags from a registration. Delete the provided tags for this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


468
469
470
471
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 468

def delete_registration_tags(registration_id, tags, opts = {})
  delete_registration_tags_with_http_info(registration_id, tags, opts)
  return nil
end

#delete_registration_tags_with_http_info(registration_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete tags from a registration. Delete the provided tags for this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 479

def delete_registration_tags_with_http_info(registration_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_tags ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags" if registration_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags" if tags.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/tags".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(tags)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#delete_registration_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_registration_with_http_info(registration_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a registration. Delete &#x60;registrationId&#x60;. This includes all instances of this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 201

def delete_registration_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_registration(registration_id, opts = {}) ⇒ nil

See if a registration exists. This method is meant to check if a registration with ‘registrationId` exists in the system.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


523
524
525
526
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 523

def get_registration(registration_id, opts = {})
  get_registration_with_http_info(registration_id, opts)
  return nil
end

#get_registration_configuration(registration_id, opts = {}) ⇒ SettingListSchema

Get registration configuration. Returns all configuration settings for this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :include_metadata (BOOLEAN) — default: default to false

Returns:



576
577
578
579
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 576

def get_registration_configuration(registration_id, opts = {})
  data, _status_code, _headers = get_registration_configuration_with_http_info(registration_id, opts)
  return data
end

#get_registration_configuration_with_http_info(registration_id, opts = {}) ⇒ Array<(SettingListSchema, Fixnum, Hash)>

Get registration configuration. Returns all configuration settings for this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :include_metadata (BOOLEAN)

Returns:

  • (Array<(SettingListSchema, Fixnum, Hash)>) —

    SettingListSchema data, response status code and response headers



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 587

def get_registration_configuration_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_configuration ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'SettingListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_instance_configuration(registration_id, instance_id, opts = {}) ⇒ SettingListSchema

Get configuration for instance of registration. Returns all configuration settings for this registration instance.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :include_metadata (BOOLEAN) — default: default to false

Returns:



633
634
635
636
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 633

def get_registration_instance_configuration(registration_id, instance_id, opts = {})
  data, _status_code, _headers = get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts)
  return data
end

#get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts = {}) ⇒ Array<(SettingListSchema, Fixnum, Hash)>

Get configuration for instance of registration. Returns all configuration settings for this registration instance.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :include_metadata (BOOLEAN)

Returns:

  • (Array<(SettingListSchema, Fixnum, Hash)>) —

    SettingListSchema data, response status code and response headers



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 645

def get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_configuration ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration" if registration_id.nil?
  # verify the required parameter 'instance_id' is set
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration" if instance_id.nil?
  if instance_id < 0
    fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_configuration, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/registrations/{registrationId}/instances/{instanceId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'SettingListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_instance_launch_history(registration_id, instance_id, opts = {}) ⇒ LaunchHistoryListSchema

Get launch history for an instance of a registration. Returns history of the launches of the specified instance of this registration.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :include_history_log (BOOLEAN) —

    Whether to include the history log in the launch history (default to false)

Returns:



697
698
699
700
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 697

def get_registration_instance_launch_history(registration_id, instance_id, opts = {})
  data, _status_code, _headers = get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts)
  return data
end

#get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts = {}) ⇒ Array<(LaunchHistoryListSchema, Fixnum, Hash)>

Get launch history for an instance of a registration. Returns history of the launches of the specified instance of this registration.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :include_history_log (BOOLEAN) —

    Whether to include the history log in the launch history

Returns:

  • (Array<(LaunchHistoryListSchema, Fixnum, Hash)>) —

    LaunchHistoryListSchema data, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 709

def get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_launch_history ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history" if registration_id.nil?
  # verify the required parameter 'instance_id' is set
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history" if instance_id.nil?
  if instance_id < 0
    fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_launch_history, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/registrations/{registrationId}/instances/{instanceId}/launchHistory".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeHistoryLog'] = opts[:'include_history_log'] if !opts[:'include_history_log'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'LaunchHistoryListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_launch_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_instance_progress(registration_id, instance_id, opts = {}) ⇒ RegistrationSchema

Get details of an instance of a registration. Get registration progress for instance ‘instanceId` of `registrationId`’

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results (default to false)

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results (default to false)

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results (default to false)

Returns:



763
764
765
766
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 763

def get_registration_instance_progress(registration_id, instance_id, opts = {})
  data, _status_code, _headers = get_registration_instance_progress_with_http_info(registration_id, instance_id, opts)
  return data
end

#get_registration_instance_progress_with_http_info(registration_id, instance_id, opts = {}) ⇒ Array<(RegistrationSchema, Fixnum, Hash)>

Get details of an instance of a registration. Get registration progress for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;&#39;

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results

Returns:

  • (Array<(RegistrationSchema, Fixnum, Hash)>) —

    RegistrationSchema data, response status code and response headers



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 777

def get_registration_instance_progress_with_http_info(registration_id, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_progress ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress" if registration_id.nil?
  # verify the required parameter 'instance_id' is set
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress" if instance_id.nil?
  if instance_id < 0
    fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_progress, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/registrations/{registrationId}/instances/{instanceId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'RegistrationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_instance_statements(registration_id, instance_id, opts = {}) ⇒ XapiStatementResult

Get xAPI statements for an instance of a registration. Get xAPI statements for instance ‘instanceId` of `registrationId`.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



833
834
835
836
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 833

def get_registration_instance_statements(registration_id, instance_id, opts = {})
  data, _status_code, _headers = get_registration_instance_statements_with_http_info(registration_id, instance_id, opts)
  return data
end

#get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {}) ⇒ Array<(XapiStatementResult, Fixnum, Hash)>

Get xAPI statements for an instance of a registration. Get xAPI statements for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(XapiStatementResult, Fixnum, Hash)>) —

    XapiStatementResult data, response status code and response headers



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 847

def get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_statements ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements" if registration_id.nil?
  # verify the required parameter 'instance_id' is set
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements" if instance_id.nil?
  if instance_id < 0
    fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_statements, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = "/registrations/{registrationId}/instances/{instanceId}/xAPIStatements".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'XapiStatementResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_instances(registration_id, opts = {}) ⇒ RegistrationListSchema

Get all instances of a registration. Get all the instances of this the registration specified by the registration ID

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results (default to false)

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results (default to false)

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results (default to false)

Returns:



905
906
907
908
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 905

def get_registration_instances(registration_id, opts = {})
  data, _status_code, _headers = get_registration_instances_with_http_info(registration_id, opts)
  return data
end

#get_registration_instances_with_http_info(registration_id, opts = {}) ⇒ Array<(RegistrationListSchema, Fixnum, Hash)>

Get all instances of a registration. Get all the instances of this the registration specified by the registration ID

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results

Returns:

  • (Array<(RegistrationListSchema, Fixnum, Hash)>) —

    RegistrationListSchema data, response status code and response headers



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 921

def get_registration_instances_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instances ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/instances".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'RegistrationListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_launch_history(registration_id, opts = {}) ⇒ LaunchHistoryListSchema

Get launch history for a registration. Returns history of this registration’s launches.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :include_history_log (BOOLEAN) —

    Whether to include the history log in the launch history (default to false)

Returns:



971
972
973
974
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 971

def get_registration_launch_history(registration_id, opts = {})
  data, _status_code, _headers = get_registration_launch_history_with_http_info(registration_id, opts)
  return data
end

#get_registration_launch_history_with_http_info(registration_id, opts = {}) ⇒ Array<(LaunchHistoryListSchema, Fixnum, Hash)>

Get launch history for a registration. Returns history of this registration&#39;s launches.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :include_history_log (BOOLEAN) —

    Whether to include the history log in the launch history

Returns:

  • (Array<(LaunchHistoryListSchema, Fixnum, Hash)>) —

    LaunchHistoryListSchema data, response status code and response headers



982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 982

def get_registration_launch_history_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_launch_history ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/launchHistory".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeHistoryLog'] = opts[:'include_history_log'] if !opts[:'include_history_log'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'LaunchHistoryListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_launch_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_progress(registration_id, opts = {}) ⇒ RegistrationSchema

Get details of a registration. Get detailed information about the latest instance of ‘registrationId`. Additional detail may be obtained by using the optional query parameters.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results (default to false)

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results (default to false)

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results (default to false)

Returns:



1029
1030
1031
1032
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1029

def get_registration_progress(registration_id, opts = {})
  data, _status_code, _headers = get_registration_progress_with_http_info(registration_id, opts)
  return data
end

#get_registration_progress_with_http_info(registration_id, opts = {}) ⇒ Array<(RegistrationSchema, Fixnum, Hash)>

Get details of a registration. Get detailed information about the latest instance of &#x60;registrationId&#x60;. Additional detail may be obtained by using the optional query parameters.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results

Returns:

  • (Array<(RegistrationSchema, Fixnum, Hash)>) —

    RegistrationSchema data, response status code and response headers



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1042

def get_registration_progress_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_progress ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'RegistrationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_statements(registration_id, opts = {}) ⇒ XapiStatementResult

Get xAPI statements for a registration. Get xAPI statements for ‘registrationId`.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



1091
1092
1093
1094
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1091

def get_registration_statements(registration_id, opts = {})
  data, _status_code, _headers = get_registration_statements_with_http_info(registration_id, opts)
  return data
end

#get_registration_statements_with_http_info(registration_id, opts = {}) ⇒ Array<(XapiStatementResult, Fixnum, Hash)>

Get xAPI statements for a registration. Get xAPI statements for &#x60;registrationId&#x60;.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(XapiStatementResult, Fixnum, Hash)>) —

    XapiStatementResult data, response status code and response headers



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1104

def get_registration_statements_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_statements ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/xAPIStatements".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'XapiStatementResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_tags(registration_id, opts = {}) ⇒ TagListSchema

Get tags for a registration. Get a list of the tags applied to this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:



1150
1151
1152
1153
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1150

def get_registration_tags(registration_id, opts = {})
  data, _status_code, _headers = get_registration_tags_with_http_info(registration_id, opts)
  return data
end

#get_registration_tags_with_http_info(registration_id, opts = {}) ⇒ Array<(TagListSchema, Fixnum, Hash)>

Get tags for a registration. Get a list of the tags applied to this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(TagListSchema, Fixnum, Hash)>) —

    TagListSchema data, response status code and response headers



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1160

def get_registration_tags_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_tags ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/tags".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'TagListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registration_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_registration_with_http_info(registration_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

See if a registration exists. This method is meant to check if a registration with &#x60;registrationId&#x60; exists in the system.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 533

def get_registration_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration" if registration_id.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_registrations(opts = {}) ⇒ RegistrationListSchema

Get a list of all registrations. Gets a list of registrations including a summary of the status of each registration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only registrations for the specified course id will be included.

  • :learner_id (String) —

    Only registrations for the specified learner id will be included.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results (default to false)

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results (default to false)

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results (default to false)

  • :tags (Array<String>)

Returns:



1211
1212
1213
1214
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1211

def get_registrations(opts = {})
  data, _status_code, _headers = get_registrations_with_http_info(opts)
  return data
end

#get_registrations_with_http_info(opts = {}) ⇒ Array<(RegistrationListSchema, Fixnum, Hash)>

Get a list of all registrations. Gets a list of registrations including a summary of the status of each registration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only registrations for the specified course id will be included.

  • :learner_id (String) —

    Only registrations for the specified learner id will be included.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :include_child_results (BOOLEAN) —

    Include information about each learning object, not just the top level in the results

  • :include_interactions_and_objectives (BOOLEAN) —

    Include interactions and objectives in the results

  • :include_runtime (BOOLEAN) —

    Include runtime details in the results

  • :tags (Array<String>)

Returns:

  • (Array<(RegistrationListSchema, Fixnum, Hash)>) —

    RegistrationListSchema data, response status code and response headers



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1229

def get_registrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.get_registrations ..."
  end
  # resource path
  local_var_path = "/registrations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'learnerId'] = opts[:'learner_id'] if !opts[:'learner_id'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'RegistrationListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#get_registrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_registration_tags(registration_id, tags, opts = {}) ⇒ nil

Set tags on a registration. Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


1280
1281
1282
1283
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1280

def put_registration_tags(registration_id, tags, opts = {})
  put_registration_tags_with_http_info(registration_id, tags, opts)
  return nil
end

#put_registration_tags_batch(batch, opts = {}) ⇒ nil

Set tags on registrations. Sets all of the provided tags on all of the provided registrations.

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

  • (nil) 


1335
1336
1337
1338
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1335

def put_registration_tags_batch(batch, opts = {})
  put_registration_tags_batch_with_http_info(batch, opts)
  return nil
end

#put_registration_tags_batch_with_http_info(batch, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set tags on registrations. Sets all of the provided tags on all of the provided registrations.

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1345

def put_registration_tags_batch_with_http_info(batch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.put_registration_tags_batch ..."
  end
  # verify the required parameter 'batch' is set
  fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch" if batch.nil?
  # resource path
  local_var_path = "/registrations/tags".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(batch)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#put_registration_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_registration_tags_with_http_info(registration_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set tags on a registration. Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1291

def put_registration_tags_with_http_info(registration_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.put_registration_tags ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags" if registration_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags" if tags.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/tags".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(tags)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#put_registration_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_registration_configuration(registration_id, configuration_settings, opts = {}) ⇒ nil

Set registration configuration. Set configuration settings for this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (nil) 


1388
1389
1390
1391
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1388

def set_registration_configuration(registration_id, configuration_settings, opts = {})
  set_registration_configuration_with_http_info(registration_id, configuration_settings, opts)
  return nil
end

#set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set registration configuration. Set configuration settings for this registration.

Parameters:

  • registration_id —

    id for this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1399

def set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.set_registration_configuration ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration" if registration_id.nil?
  # verify the required parameter 'configuration_settings' is set
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration" if configuration_settings.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(configuration_settings)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#set_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_registration_instance_configuration(registration_id, instance_id, configuration_settings, opts = {}) ⇒ nil

Set configuration for instance of registration. Set configuration settings for this registration instance.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Returns:

  • (nil) 


1445
1446
1447
1448
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1445

def set_registration_instance_configuration(registration_id, instance_id, configuration_settings, opts = {})
  set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts)
  return nil
end

#set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set configuration for instance of registration. Set configuration settings for this registration instance.

Parameters:

  • registration_id —

    id for this registration

  • instance_id —

    The instance of this registration

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1457

def set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.set_registration_instance_configuration ..."
  end
  # verify the required parameter 'registration_id' is set
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration" if registration_id.nil?
  # verify the required parameter 'instance_id' is set
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration" if instance_id.nil?
  if instance_id < 0
    fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.set_registration_instance_configuration, must be greater than or equal to 0.'
  end

  # verify the required parameter 'configuration_settings' is set
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration" if configuration_settings.nil?
  # resource path
  local_var_path = "/registrations/{registrationId}/instances/{instanceId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(configuration_settings)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#set_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_registration_postback(post_back, opts = {}) ⇒ nil

Send a test postback with a provided configuration. This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1507
1508
1509
1510
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1507

def test_registration_postback(post_back, opts = {})
  test_registration_postback_with_http_info(post_back, opts)
  return nil
end

#test_registration_postback_with_http_info(post_back, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Send a test postback with a provided configuration. This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1517

def test_registration_postback_with_http_info(post_back, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RegistrationApi.test_registration_postback ..."
  end
  # verify the required parameter 'post_back' is set
  fail ArgumentError, "Missing the required parameter 'post_back' when calling RegistrationApi.test_registration_postback" if post_back.nil?
  # resource path
  local_var_path = "/registrations/postBackTest".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(post_back)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#test_registration_postback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end