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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

Get a launch link for a Registration Returns the launch link to use to launch the course for the registration. Launch links are meant as a way to provide access to your content. When a learner visits the link, the course will be launched and registration progress will start to be tracked.

Parameters:

  • registration_id
  • 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)
  data
end

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

Get a launch link for a Registration Returns the launch link to use to launch the course for the registration. Launch links are meant as a way to provide access to your content. When a learner visits the link, the course will be launched and registration progress will start to be tracked.

Parameters:

  • registration_id
  • 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
78
79
80
81
 
# 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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.build_registration_launch_link"
  end
  # verify the required parameter 'launch_link_request' is set
  if launch_link_request.nil?
    fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.build_registration_launch_link"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/launchLink'.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 Registration Instance Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is "launched", the course specified at creation time will be launched.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 87

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

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

Create a Registration Instance Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is &quot;launched&quot;, the course specified at creation time will be launched.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
130
131
132
133
134
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 97

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances'.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 Creates a new registration. Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course. A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. 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) —

    Unless you have a reason for using this you probably do not need to.

Returns:

  • (nil) 


141
142
143
144
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 141

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

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

Create a Registration Creates a new registration. Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course. A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. A registration must be tied to a specific course at creation time. When the created registration is &quot;launched&quot;, the course specified at creation time will be launched.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_version (Integer) —

    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



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
185
186
187
188
189
190
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 152

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
  if registration.nil?
    fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration"
  end
  # resource path
  local_var_path = '/registrations'

  # 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 Deletes the specified registration. >Caution: >This will also delete all instances of the registration.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


196
197
198
199
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 196

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

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

Delete a configuration setting explicitly set for a Registration Clears the specified setting from the registration. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


250
251
252
253
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 250

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

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

Delete a configuration setting explicitly set for a Registration Clears the specified setting from the registration. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 261

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting"
  end
  # verify the required parameter 'setting_id' is set
  if setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/configuration/{settingId}'.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

Reset global data for a Registration Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


308
309
310
311
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 308

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

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

Reset global data for a Registration Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_global_data"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/globalData'.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(registration_id, instance_id, opts = {}) ⇒ nil

Delete a Registration Instance Deletes the specified instance of the registration. If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


362
363
364
365
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 362

def delete_registration_instance(registration_id, instance_id, opts = {})
  delete_registration_instance_with_http_info(registration_id, instance_id, opts)
  nil
end

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

Delete a configuration setting explicitly set for a Registration Instance Clears the specified setting from the registration instance. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


422
423
424
425
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 422

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)
  nil
end

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

Delete a configuration setting explicitly set for a Registration Instance Clears the specified setting from the registration instance. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 434

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
  end
  # verify the required parameter 'setting_id' is set
  if setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}'.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_instance_with_http_info(registration_id, instance_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Registration Instance Deletes the specified instance of the registration. If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
409
410
411
412
413
414
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 373

def delete_registration_instance_with_http_info(registration_id, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance ...'
  end
  # verify the required parameter 'registration_id' is set
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.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 = 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\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 Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


485
486
487
488
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 485

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

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

Reset a Registration Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 495

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/progress'.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 Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


539
540
541
542
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 539

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

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

Delete tags from a Registration Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 550

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags"
  end
  # verify the required parameter 'tags' is set
  if tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/tags'.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 Deletes the specified registration. &gt;Caution: &gt;This will also delete all instances of the registration.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
237
238
239
240
241
242
243
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 206

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}'.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

Check that a Registration exists Checks that the registration exists within SCORM Cloud. >Info: >No registration data will be returned for this call. A successful ‘200` response indicates that the registration exists. If the registration does not exist, a `404` error will be returned instead. If you are looking for information about the registration, try calling `GetRegistrationProgress` instead.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


597
598
599
600
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 597

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

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

Get effective configuration settings for a Registration Returns the effective configuration settings for the registration. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



651
652
653
654
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 651

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

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

Get effective configuration settings for a Registration Returns the effective configuration settings for the registration. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

  • registration_id
  • 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



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
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 662

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/configuration'.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 effective configuration settings for a Registration Instance Returns the effective configuration settings for the registration instance. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



709
710
711
712
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 709

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)
  data
end

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

Get effective configuration settings for a Registration Instance Returns the effective configuration settings for the registration instance. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

  • registration_id
  • instance_id
  • 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



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
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 721

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.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 a Registration Instance Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.

Parameters:

  • registration_id
  • instance_id
  • 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:



772
773
774
775
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 772

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)
  data
end

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

Get launch history for a Registration Instance Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.

Parameters:

  • registration_id
  • instance_id
  • 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



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
823
824
825
826
827
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 784

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/launchHistory'.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 detailed information about a Registration Instance Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.

Parameters:

  • registration_id
  • instance_id
  • 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:



837
838
839
840
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 837

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)
  data
end

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

Get detailed information about a Registration Instance Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.

Parameters:

  • registration_id
  • instance_id
  • 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



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
893
894
895
896
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 851

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.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 a Registration Instance Returns xAPI statements for the registration instance.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

Returns:



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

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)
  data
end

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

Get xAPI statements for a Registration Instance Returns xAPI statements for the registration instance.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

Returns:

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

    XapiStatementResult data, response status code and response headers



920
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
964
965
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 920

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/xAPIStatements'.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 a list of a Registration’s Instances Returns information about all instances of the registration. This can be useful to see information such as registration progress across versions of a course.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :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:



977
978
979
980
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 977

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

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

Get a list of a Registration&#39;s Instances Returns information about all instances of the registration. This can be useful to see information such as registration progress across versions of a course.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :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



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
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 993

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances'.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 the launch history of the registration. This includes completion status, time taken, and pass/fail status.

Parameters:

  • registration_id
  • 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:



1044
1045
1046
1047
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1044

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

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

Get launch history for a Registration Returns the launch history of the registration. This includes completion status, time taken, and pass/fail status.

Parameters:

  • registration_id
  • 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



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
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1055

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/launchHistory'.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 detailed information about a Registration Returns detailed information about the registration. This includes completion status, time taken, score, and pass/fail status. >Info: >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.

Parameters:

  • registration_id
  • 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:



1103
1104
1105
1106
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1103

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

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

Get detailed information about a Registration Returns detailed information about the registration. This includes completion status, time taken, score, and pass/fail status. &gt;Info: &gt;If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.

Parameters:

  • registration_id
  • 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



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
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1116

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}'.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 Returns xAPI statements for the registration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

Returns:



1166
1167
1168
1169
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1166

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

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

Get xAPI statements for a Registration Returns xAPI statements for the registration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

Returns:

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

    XapiStatementResult data, response status code and response headers



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1179

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/xAPIStatements'.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 Returns the tags for the registration.

Parameters:

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

    the optional parameters

Returns:



1226
1227
1228
1229
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1226

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

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

Get tags for a Registration Returns the tags for the registration.

Parameters:

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

    the optional parameters

Returns:

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

    TagListSchema data, response status code and response headers



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
1273
1274
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1236

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/tags'.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)>

Check that a Registration exists Checks that the registration exists within SCORM Cloud. &gt;Info: &gt;No registration data will be returned for this call. A successful &#x60;200&#x60; response indicates that the registration exists. If the registration does not exist, a &#x60;404&#x60; error will be returned instead. If you are looking for information about the registration, try calling &#x60;GetRegistrationProgress&#x60; instead.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 607

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}'.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 Registrations Returns a list of registrations. Can be filtered using the request parameters to provide a subset of results. >Note: >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a ‘more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >Info: >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :learner_id (String) —

    Only retrieve resources having &#x60;learnerId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to created)

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. (default to created_desc)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :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:



1292
1293
1294
1295
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1292

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

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

Get a list of Registrations Returns a list of registrations. Can be filtered using the request parameters to provide a subset of results. &gt;Note: &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. &gt;Info: &gt;If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :learner_id (String) —

    Only retrieve resources having &#x60;learnerId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results.

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :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



1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1314

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'

  # 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[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].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_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

Add tags to a Registration Applies the provided tags to the registration. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1368
1369
1370
1371
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1368

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

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

Add a group of tags to a group of Registrations Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).

Parameters:

  • batch —

    Array of ids, and array of tags for bulk tag operations

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

    the optional parameters

Returns:

  • (nil) 


1426
1427
1428
1429
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1426

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

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

Add a group of tags to a group of Registrations Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).

Parameters:

  • batch —

    Array of ids, and array of tags for bulk tag operations

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1436

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
  if batch.nil?
    fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch"
  end
  # resource path
  local_var_path = '/registrations/tags'

  # 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)>

Add tags to a Registration Applies the provided tags to the registration. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1379

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags"
  end
  # verify the required parameter 'tags' is set
  if tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/tags'.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

Update configuration settings for a Registration Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1480
1481
1482
1483
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1480

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

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

Update configuration settings for a Registration Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1491

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration"
  end
  # verify the required parameter 'configuration_settings' is set
  if configuration_settings.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/configuration'.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

Update configuration settings for a Registration Instance Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1540
1541
1542
1543
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1540

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)
  nil
end

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

Update configuration settings for a Registration Instance Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1552

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
  if registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration"
  end
  # verify the required parameter 'instance_id' is set
  if instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration"
  end
  # verify the required parameter 'configuration_settings' is set
  if configuration_settings.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration"
  end
  # resource path
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.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 the provided configuration Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether ‘httpbasic` or `form` is passed for `authType`. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. >Note: >The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


1603
1604
1605
1606
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1603

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

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

Send a test postback with the provided configuration Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether &#x60;httpbasic&#x60; or &#x60;form&#x60; is passed for &#x60;authType&#x60;. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. &gt;Note: &gt;The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'lib/rustici_software_cloud_v2/api/registration_api.rb', line 1613

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
  if post_back.nil?
    fail ArgumentError, "Missing the required parameter 'post_back' when calling RegistrationApi.test_registration_postback"
  end
  # resource path
  local_var_path = '/registrations/postBackTest'

  # 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