Class: EdmentumClient::V20CoursewareApi

Inherits:
Object
  • Object
show all
Defined in:
lib/edmentum_client/api/v20_courseware_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V20CoursewareApi

Returns a new instance of V20CoursewareApi.



19
20
21
 
# File 'lib/edmentum_client/api/v20_courseware_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/edmentum_client/api/v20_courseware_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#classes_controller_enroll_courseware_user(classid, userid, opts = {}) ⇒ String

Enroll a user in a Courseware class.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_date (DateTime) —

    End Date needs to be greater than Start Date (time of day is ignored).

  • :end_date (DateTime)

Returns:

  • (String) 


29
30
31
32
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 29

def classes_controller_enroll_courseware_user(classid, userid, opts = {})
  data, _status_code, _headers = classes_controller_enroll_courseware_user_with_http_info(classid, userid, opts)
  data
end

#classes_controller_enroll_courseware_user_with_http_info(classid, userid, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Enroll a user in a Courseware class.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :start_date (DateTime) —

    End Date needs to be greater than Start Date (time of day is ignored).

  • :end_date (DateTime)

Returns:

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

    String data, response status code and response headers



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
82
83
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 41

def classes_controller_enroll_courseware_user_with_http_info(classid, userid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_enroll_courseware_user ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_enroll_courseware_user"
  end
  # verify the required parameter 'userid' is set
  if @api_client.config.client_side_validation && userid.nil?
    fail ArgumentError, "Missing the required parameter 'userid' when calling V20CoursewareApi.classes_controller_enroll_courseware_user"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/users/{userid}'.sub('{' + 'classid' + '}', classid.to_s).sub('{' + 'userid' + '}', userid.to_s)

  # query parameters
  query_params = {}
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

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

  # form parameters
  form_params = {}

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

#classes_controller_get_activities(classid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsActivity

Get Class Activities from GradeTracker

Parameters:

  • classid —

    The ID of the class

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

    the optional parameters

Options Hash (opts):

  • :gradetracker_category_id (Integer) — default: Optional —

    When supplied, filters the results down to just the given gradetrackerCategoryId.

Returns:



89
90
91
92
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 89

def classes_controller_get_activities(classid, opts = {})
  data, _status_code, _headers = classes_controller_get_activities_with_http_info(classid, opts)
  data
end

#classes_controller_get_activities_with_http_info(classid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsActivity, Fixnum, Hash)>

Get Class Activities from GradeTracker

Parameters:

  • classid —

    The ID of the class

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

    the optional parameters

Options Hash (opts):

  • :gradetracker_category_id (Integer) — default: Optional —

    When supplied, filters the results down to just the given gradetrackerCategoryId.

Returns:



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
135
136
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 99

def classes_controller_get_activities_with_http_info(classid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_activities ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_activities"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/gradetracker/activities'.sub('{' + 'classid' + '}', classid.to_s)

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

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

  # form parameters
  form_params = {}

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

#classes_controller_get_activity_scores(classid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsActivityScore

Get Class Activity Scores from GradeTracker

Parameters:

  • classid —

    The ID of the class

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

    the optional parameters

Options Hash (opts):

  • :resource_node_id (Integer) — default: Optional —

    When supplied, filters to the results down to just the given resoureNodeId.

  • :learner_user_id (Integer) — default: Optional —

    When supplied, filters to the results down to just the given learnerUserId.

Returns:



143
144
145
146
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 143

def classes_controller_get_activity_scores(classid, opts = {})
  data, _status_code, _headers = classes_controller_get_activity_scores_with_http_info(classid, opts)
  data
end

#classes_controller_get_activity_scores_with_http_info(classid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsActivityScore, Fixnum, Hash)>

Get Class Activity Scores from GradeTracker

Parameters:

  • classid —

    The ID of the class

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

    the optional parameters

Options Hash (opts):

  • :resource_node_id (Integer) — default: Optional —

    When supplied, filters to the results down to just the given resoureNodeId.

  • :learner_user_id (Integer) — default: Optional —

    When supplied, filters to the results down to just the given learnerUserId.

Returns:



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
191
192
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 154

def classes_controller_get_activity_scores_with_http_info(classid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_activity_scores ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_activity_scores"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/gradetracker/activityscores'.sub('{' + 'classid' + '}', classid.to_s)

  # query parameters
  query_params = {}
  query_params[:'resourceNodeId'] = opts[:'resource_node_id'] if !opts[:'resource_node_id'].nil?
  query_params[:'learnerUserId'] = opts[:'learner_user_id'] if !opts[:'learner_user_id'].nil?

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

  # form parameters
  form_params = {}

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

#classes_controller_get_courseware_class_activity_progress(classid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsActivityProgress

Get current progress for all students in a Courseware class.

Parameters:

  • classid —

    Class ID to get progress for.

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

    the optional parameters

Returns:



197
198
199
200
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 197

def classes_controller_get_courseware_class_activity_progress(classid, opts = {})
  data, _status_code, _headers = classes_controller_get_courseware_class_activity_progress_with_http_info(classid, opts)
  data
end

#classes_controller_get_courseware_class_activity_progress_with_http_info(classid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsActivityProgress, Fixnum, Hash)>

Get current progress for all students in a Courseware class.

Parameters:

  • classid —

    Class ID to get progress for.

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

    the optional parameters

Returns:



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
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 206

def classes_controller_get_courseware_class_activity_progress_with_http_info(classid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_courseware_class_activity_progress ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_courseware_class_activity_progress"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/gradetracker/progress'.sub('{' + 'classid' + '}', classid.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', 'text/json'])

  # form parameters
  form_params = {}

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

#classes_controller_get_courseware_class_activity_time_on_task(classid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsActivityTimeOnTask

Get daily activity time on task records for all students in a Courseware class.
TimeOnTask (in minutes) property is obsolete, use TimeOnTaskInMilliseconds instead. </br>

Parameters:

  • classid —

    Class ID to get time on task for.

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

    the optional parameters

Options Hash (opts):

  • :startdate (DateTime) —

    Optional Start Date, if not provided - returns all activity time on task data for that class.

Returns:



249
250
251
252
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 249

def classes_controller_get_courseware_class_activity_time_on_task(classid, opts = {})
  data, _status_code, _headers = classes_controller_get_courseware_class_activity_time_on_task_with_http_info(classid, opts)
  data
end

#classes_controller_get_courseware_class_activity_time_on_task_with_http_info(classid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsActivityTimeOnTask, Fixnum, Hash)>

Get daily activity time on task records for all students in a Courseware class. &lt;br&gt; &lt;b&gt;TimeOnTask (in minutes) property is obsolete, use TimeOnTaskInMilliseconds instead.&lt;/b&gt; &lt;/br&gt;

Parameters:

  • classid —

    Class ID to get time on task for.

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

    the optional parameters

Options Hash (opts):

  • :startdate (DateTime) —

    Optional Start Date, if not provided - returns all activity time on task data for that class.

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 260

def classes_controller_get_courseware_class_activity_time_on_task_with_http_info(classid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_courseware_class_activity_time_on_task ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_courseware_class_activity_time_on_task"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/timeontask'.sub('{' + 'classid' + '}', classid.to_s)

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

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

  # form parameters
  form_params = {}

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

#classes_controller_get_courseware_class_learner_grades(classid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsCoursewareClassLearnerGrade

Get current grades for all students in a Courseware class.

Parameters:

  • classid —

    Class ID to get grades for.

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 302

def classes_controller_get_courseware_class_learner_grades(classid, opts = {})
  data, _status_code, _headers = classes_controller_get_courseware_class_learner_grades_with_http_info(classid, opts)
  data
end

#classes_controller_get_courseware_class_learner_grades_with_http_info(classid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsCoursewareClassLearnerGrade, Fixnum, Hash)>

Get current grades for all students in a Courseware class.

Parameters:

  • classid —

    Class ID to get grades for.

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

    the optional parameters

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 311

def classes_controller_get_courseware_class_learner_grades_with_http_info(classid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_courseware_class_learner_grades ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_courseware_class_learner_grades"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/gradetracker/grades'.sub('{' + 'classid' + '}', classid.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', 'text/json'])

  # form parameters
  form_params = {}

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

#classes_controller_get_courseware_enrollable_users(classid, pagesize, opts = {}) ⇒ EdApiPageableResultsWithCountEdApiModelsUser

Get list of users to enroll in a Courseware class. <ul> <li>This dataset can be quite large so result sets are paged using $pagesize and $skip parameters.</li> <li>$pagesize represents the number of results to return in a request, with a maximum $pagesize of 10000.</li> <li>If no $skip is provided, the call will return the first page of the result set.</li> <li>The next set of records can be obtained by making a request to the value of the "Next" field returned in the response.</li> </ul>
For example:</br> <ul> <li>?$pagesize=10000&amp;$skip=10000 - get results from 10000 - 19999 (next 10000 records).</li> <li>"Next": "/courseware/v2.0/classes/classid/enrollableusers?$pagesize=10000&amp;$skip=10000"</li> </ul>

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)

Returns:



355
356
357
358
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 355

def classes_controller_get_courseware_enrollable_users(classid, pagesize, opts = {})
  data, _status_code, _headers = classes_controller_get_courseware_enrollable_users_with_http_info(classid, pagesize, opts)
  data
end

#classes_controller_get_courseware_enrollable_users_with_http_info(classid, pagesize, opts = {}) ⇒ Array<(EdApiPageableResultsWithCountEdApiModelsUser, Fixnum, Hash)>

Get list of users to enroll in a Courseware class. &lt;ul&gt; &lt;li&gt;This dataset can be quite large so result sets are paged using $pagesize and $skip parameters.&lt;/li&gt; &lt;li&gt;$pagesize represents the number of results to return in a request, with a maximum $pagesize of 10000.&lt;/li&gt; &lt;li&gt;If no $skip is provided, the call will return the first page of the result set.&lt;/li&gt; &lt;li&gt;The next set of records can be obtained by making a request to the value of the &quot;Next&quot; field returned in the response.&lt;/li&gt; &lt;/ul&gt; &lt;br&gt;For example:&lt;/br&gt; &lt;ul&gt; &lt;li&gt;?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000 - get results from 10000 - 19999 (next 10000 records).&lt;/li&gt; &lt;li&gt;&quot;Next&quot;: &quot;/courseware/v2.0/classes/classid/enrollableusers?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000&quot;&lt;/li&gt; &lt;/ul&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)

Returns:



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

def classes_controller_get_courseware_enrollable_users_with_http_info(classid, pagesize, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_courseware_enrollable_users ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_courseware_enrollable_users"
  end
  # verify the required parameter 'pagesize' is set
  if @api_client.config.client_side_validation && pagesize.nil?
    fail ArgumentError, "Missing the required parameter 'pagesize' when calling V20CoursewareApi.classes_controller_get_courseware_enrollable_users"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/enrollableusers'.sub('{' + 'classid' + '}', classid.to_s)

  # query parameters
  query_params = {}
  query_params[:'$pagesize'] = pagesize
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?

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

  # form parameters
  form_params = {}

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

#classes_controller_get_courseware_user(classid, user_id, opts = {}) ⇒ EdApiModelsUserClassAssignment

Get a single user by classid and userid

Parameters:

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

    the optional parameters

Returns:



415
416
417
418
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 415

def classes_controller_get_courseware_user(classid, user_id, opts = {})
  data, _status_code, _headers = classes_controller_get_courseware_user_with_http_info(classid, user_id, opts)
  data
end

#classes_controller_get_courseware_user_with_http_info(classid, user_id, opts = {}) ⇒ Array<(EdApiModelsUserClassAssignment, Fixnum, Hash)>

Get a single user by classid and userid

Parameters:

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

    the optional parameters

Returns:



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

def classes_controller_get_courseware_user_with_http_info(classid, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_courseware_user ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_courseware_user"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling V20CoursewareApi.classes_controller_get_courseware_user"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/users/{userId}'.sub('{' + 'classid' + '}', classid.to_s).sub('{' + 'userId' + '}', user_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', 'text/json'])

  # form parameters
  form_params = {}

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

#classes_controller_get_courseware_users(classid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsUserClassAssignment

Get a list of users in a Courseware class.

Parameters:

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

    the optional parameters

Returns:



470
471
472
473
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 470

def classes_controller_get_courseware_users(classid, opts = {})
  data, _status_code, _headers = classes_controller_get_courseware_users_with_http_info(classid, opts)
  data
end

#classes_controller_get_courseware_users_with_http_info(classid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsUserClassAssignment, Fixnum, Hash)>

Get a list of users in a Courseware class.

Parameters:

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

    the optional parameters

Returns:



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

def classes_controller_get_courseware_users_with_http_info(classid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_get_courseware_users ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_get_courseware_users"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/users'.sub('{' + 'classid' + '}', classid.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', 'text/json'])

  # form parameters
  form_params = {}

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

#classes_controller_transfer_learner_to_new_class(class_id, transfer, opts = {}) ⇒ String

Transfer Learner from one class to another

Parameters:

  • class_id —

    Classroom Id pertaining to classroom to transfer learner

  • transfer —

    Transfer object representing LearnerUserId of learner to be transferred and the ClassroomId of the learner&#39;s current class

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

    the optional parameters

Returns:

  • (String) 


521
522
523
524
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 521

def classes_controller_transfer_learner_to_new_class(class_id, transfer, opts = {})
  data, _status_code, _headers = classes_controller_transfer_learner_to_new_class_with_http_info(class_id, transfer, opts)
  data
end

#classes_controller_transfer_learner_to_new_class_with_http_info(class_id, transfer, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Transfer Learner from one class to another

Parameters:

  • class_id —

    Classroom Id pertaining to classroom to transfer learner

  • transfer —

    Transfer object representing LearnerUserId of learner to be transferred and the ClassroomId of the learner&#39;s current class

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def classes_controller_transfer_learner_to_new_class_with_http_info(class_id, transfer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_transfer_learner_to_new_class ...'
  end
  # verify the required parameter 'class_id' is set
  if @api_client.config.client_side_validation && class_id.nil?
    fail ArgumentError, "Missing the required parameter 'class_id' when calling V20CoursewareApi.classes_controller_transfer_learner_to_new_class"
  end
  # verify the required parameter 'transfer' is set
  if @api_client.config.client_side_validation && transfer.nil?
    fail ArgumentError, "Missing the required parameter 'transfer' when calling V20CoursewareApi.classes_controller_transfer_learner_to_new_class"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classId}/transfer'.sub('{' + 'classId' + '}', class_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', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(transfer)
  auth_names = opts[:auth_names] || ["Oauth2_Access_Token"]
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20CoursewareApi#classes_controller_transfer_learner_to_new_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_update_class_status(classid, resourcenodeid, model, opts = {}) ⇒ EdApiModelsClassStatus

Lock/Unlock content for an entire Courseware class including students added later.

Parameters:

  • classid
  • resourcenodeid
  • model —

    &lt;br&gt; Locking/Unlocking a resource node locks/unlocks all children nodes &lt;/br&gt;

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

    the optional parameters

Returns:



580
581
582
583
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 580

def classes_controller_update_class_status(classid, resourcenodeid, model, opts = {})
  data, _status_code, _headers = classes_controller_update_class_status_with_http_info(classid, resourcenodeid, model, opts)
  data
end

#classes_controller_update_class_status_with_http_info(classid, resourcenodeid, model, opts = {}) ⇒ Array<(EdApiModelsClassStatus, Fixnum, Hash)>

Lock/Unlock content for an entire Courseware class including students added later.

Parameters:

  • classid
  • resourcenodeid
  • model —

    &lt;br&gt; Locking/Unlocking a resource node locks/unlocks all children nodes &lt;/br&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsClassStatus data, response status code and response headers



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 591

def classes_controller_update_class_status_with_http_info(classid, resourcenodeid, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_update_class_status ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_update_class_status"
  end
  # verify the required parameter 'resourcenodeid' is set
  if @api_client.config.client_side_validation && resourcenodeid.nil?
    fail ArgumentError, "Missing the required parameter 'resourcenodeid' when calling V20CoursewareApi.classes_controller_update_class_status"
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling V20CoursewareApi.classes_controller_update_class_status"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/resourcenodes/{resourcenodeid}/status'.sub('{' + 'classid' + '}', classid.to_s).sub('{' + 'resourcenodeid' + '}', resourcenodeid.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', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(model)
  auth_names = opts[:auth_names] || ["Oauth2_Access_Token"]
  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,
    :return_type => 'EdApiModelsClassStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20CoursewareApi#classes_controller_update_class_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_update_class_user_status(userid, classid, resourcenodeid, model, opts = {}) ⇒ EdApiModelsClassUserStatus

Lock/Unlock content for a particular user in a Courseware class.

Parameters:

  • userid
  • classid
  • resourcenodeid
  • model —

    &lt;br&gt; Locking/Unlocking a resource node locks/unlocks all children nodes &lt;/br&gt;

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

    the optional parameters

Returns:



645
646
647
648
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 645

def classes_controller_update_class_user_status(userid, classid, resourcenodeid, model, opts = {})
  data, _status_code, _headers = classes_controller_update_class_user_status_with_http_info(userid, classid, resourcenodeid, model, opts)
  data
end

#classes_controller_update_class_user_status_with_http_info(userid, classid, resourcenodeid, model, opts = {}) ⇒ Array<(EdApiModelsClassUserStatus, Fixnum, Hash)>

Lock/Unlock content for a particular user in a Courseware class.

Parameters:

  • userid
  • classid
  • resourcenodeid
  • model —

    &lt;br&gt; Locking/Unlocking a resource node locks/unlocks all children nodes &lt;/br&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsClassUserStatus data, response status code and response headers



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 657

def classes_controller_update_class_user_status_with_http_info(userid, classid, resourcenodeid, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_update_class_user_status ...'
  end
  # verify the required parameter 'userid' is set
  if @api_client.config.client_side_validation && userid.nil?
    fail ArgumentError, "Missing the required parameter 'userid' when calling V20CoursewareApi.classes_controller_update_class_user_status"
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_update_class_user_status"
  end
  # verify the required parameter 'resourcenodeid' is set
  if @api_client.config.client_side_validation && resourcenodeid.nil?
    fail ArgumentError, "Missing the required parameter 'resourcenodeid' when calling V20CoursewareApi.classes_controller_update_class_user_status"
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling V20CoursewareApi.classes_controller_update_class_user_status"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/users/{userid}/resourcenodes/{resourcenodeid}/status'.sub('{' + 'userid' + '}', userid.to_s).sub('{' + 'classid' + '}', classid.to_s).sub('{' + 'resourcenodeid' + '}', resourcenodeid.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', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(model)
  auth_names = opts[:auth_names] || ["Oauth2_Access_Token"]
  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,
    :return_type => 'EdApiModelsClassUserStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20CoursewareApi#classes_controller_update_class_user_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_update_courseware_class(classid, model, opts = {}) ⇒ EdApiModelsClass

Update Courseware class.

Parameters:

  • classid —

    The ID of the class to update.

  • model —

    The class to update. &lt;br&gt; ProgramID, ClassID, ResourceNodeId, ResourceNodeName and SelfEnrollCode cannot be updated once an assignment is created, so values in these parameters will be ignored.&lt;/br&gt;&lt;br&gt; Due date needs to be greater than Start Date&lt;/br&gt;&lt;br&gt; Valid value for MasteryTestAttempts is between 0 and 10. Zero value translates to Unlimited Mastery test Attempts &lt;/br&gt;

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

    the optional parameters

Returns:



713
714
715
716
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 713

def classes_controller_update_courseware_class(classid, model, opts = {})
  data, _status_code, _headers = classes_controller_update_courseware_class_with_http_info(classid, model, opts)
  data
end

#classes_controller_update_courseware_class_with_http_info(classid, model, opts = {}) ⇒ Array<(EdApiModelsClass, Fixnum, Hash)>

Update Courseware class.

Parameters:

  • classid —

    The ID of the class to update.

  • model —

    The class to update. &lt;br&gt; ProgramID, ClassID, ResourceNodeId, ResourceNodeName and SelfEnrollCode cannot be updated once an assignment is created, so values in these parameters will be ignored.&lt;/br&gt;&lt;br&gt; Due date needs to be greater than Start Date&lt;/br&gt;&lt;br&gt; Valid value for MasteryTestAttempts is between 0 and 10. Zero value translates to Unlimited Mastery test Attempts &lt;/br&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsClass data, response status code and response headers



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
765
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 723

def classes_controller_update_courseware_class_with_http_info(classid, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_update_courseware_class ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_update_courseware_class"
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling V20CoursewareApi.classes_controller_update_courseware_class"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}'.sub('{' + 'classid' + '}', classid.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', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(model)
  auth_names = opts[:auth_names] || ["Oauth2_Access_Token"]
  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,
    :return_type => 'EdApiModelsClass')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20CoursewareApi#classes_controller_update_courseware_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_update_courseware_user_enrollment(class_id, user_id, start_date, opts = {}) ⇒ String

Update start and end dates for a user’s Courseware Class.

Parameters:

  • class_id
  • user_id
  • start_date —

    End Date needs to be greater than Start Date (time of day is ignored).

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

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime)

Returns:

  • (String) 


773
774
775
776
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 773

def classes_controller_update_courseware_user_enrollment(class_id, user_id, start_date, opts = {})
  data, _status_code, _headers = classes_controller_update_courseware_user_enrollment_with_http_info(class_id, user_id, start_date, opts)
  data
end

#classes_controller_update_courseware_user_enrollment_with_http_info(class_id, user_id, start_date, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update start and end dates for a user&#39;s Courseware Class.

Parameters:

  • class_id
  • user_id
  • start_date —

    End Date needs to be greater than Start Date (time of day is ignored).

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

    the optional parameters

Options Hash (opts):

  • :end_date (DateTime)

Returns:

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

    String data, response status code and response headers



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
828
829
830
831
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 785

def classes_controller_update_courseware_user_enrollment_with_http_info(class_id, user_id, start_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_update_courseware_user_enrollment ...'
  end
  # verify the required parameter 'class_id' is set
  if @api_client.config.client_side_validation && class_id.nil?
    fail ArgumentError, "Missing the required parameter 'class_id' when calling V20CoursewareApi.classes_controller_update_courseware_user_enrollment"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling V20CoursewareApi.classes_controller_update_courseware_user_enrollment"
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling V20CoursewareApi.classes_controller_update_courseware_user_enrollment"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classId}/users/{userId}'.sub('{' + 'classId' + '}', class_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'startDate'] = start_date
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

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

  # form parameters
  form_params = {}

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

#classes_controller_withdraw_courseware_user(classid, userid, opts = {}) ⇒ String

Withdraw a user from a Courseware class.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


837
838
839
840
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 837

def classes_controller_withdraw_courseware_user(classid, userid, opts = {})
  data, _status_code, _headers = classes_controller_withdraw_courseware_user_with_http_info(classid, userid, opts)
  data
end

#classes_controller_withdraw_courseware_user_with_http_info(classid, userid, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Withdraw a user from a Courseware class.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def classes_controller_withdraw_courseware_user_with_http_info(classid, userid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.classes_controller_withdraw_courseware_user ...'
  end
  # verify the required parameter 'classid' is set
  if @api_client.config.client_side_validation && classid.nil?
    fail ArgumentError, "Missing the required parameter 'classid' when calling V20CoursewareApi.classes_controller_withdraw_courseware_user"
  end
  # verify the required parameter 'userid' is set
  if @api_client.config.client_side_validation && userid.nil?
    fail ArgumentError, "Missing the required parameter 'userid' when calling V20CoursewareApi.classes_controller_withdraw_courseware_user"
  end
  # resource path
  local_var_path = '/courseware/v2.0/classes/{classid}/users/{userid}'.sub('{' + 'classid' + '}', classid.to_s).sub('{' + 'userid' + '}', userid.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', 'text/json'])

  # form parameters
  form_params = {}

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

#programs_controller_create_program_class(programid, model, opts = {}) ⇒ EdApiModelsClass

Create a Courseware class in a program.

Parameters:

  • programid —

    The ID of the program.

  • model —

    The class to create.&lt;br /&gt;&lt;br&gt; ClassID and ResourceNodeName are optional and values in these parameters will be ignored.&lt;/br&gt;&lt;br&gt; Due date needs to be greater than Start Date&lt;/br&gt;&lt;br&gt; Valid value for MasteryTestAttempts is between 0 and 10. Zero value translates to Unlimited Mastery test Attempts&lt;/br&gt;&lt;br&gt; SelfEnrollPassword min length is 4 characters &lt;/br&gt;

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

    the optional parameters

Returns:



893
894
895
896
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 893

def programs_controller_create_program_class(programid, model, opts = {})
  data, _status_code, _headers = programs_controller_create_program_class_with_http_info(programid, model, opts)
  data
end

#programs_controller_create_program_class_with_http_info(programid, model, opts = {}) ⇒ Array<(EdApiModelsClass, Fixnum, Hash)>

Create a Courseware class in a program.

Parameters:

  • programid —

    The ID of the program.

  • model —

    The class to create.&lt;br /&gt;&lt;br&gt; ClassID and ResourceNodeName are optional and values in these parameters will be ignored.&lt;/br&gt;&lt;br&gt; Due date needs to be greater than Start Date&lt;/br&gt;&lt;br&gt; Valid value for MasteryTestAttempts is between 0 and 10. Zero value translates to Unlimited Mastery test Attempts&lt;/br&gt;&lt;br&gt; SelfEnrollPassword min length is 4 characters &lt;/br&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsClass data, response status code and response headers



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
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
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 903

def programs_controller_create_program_class_with_http_info(programid, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.programs_controller_create_program_class ...'
  end
  # verify the required parameter 'programid' is set
  if @api_client.config.client_side_validation && programid.nil?
    fail ArgumentError, "Missing the required parameter 'programid' when calling V20CoursewareApi.programs_controller_create_program_class"
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling V20CoursewareApi.programs_controller_create_program_class"
  end
  # resource path
  local_var_path = '/courseware/v2.0/programs/{programid}/classes'.sub('{' + 'programid' + '}', programid.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', 'text/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(model)
  auth_names = opts[:auth_names] || ["Oauth2_Access_Token"]
  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 => 'EdApiModelsClass')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20CoursewareApi#programs_controller_create_program_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#programs_controller_get_program_class(program_id, class_id, opts = {}) ⇒ EdApiModelsClass

Get a Courseware classes in a Courseware program by classId.

Parameters:

  • program_id —

    The ID of the program.

  • class_id —

    The ID of the class.

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

    the optional parameters

Returns:



951
952
953
954
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 951

def programs_controller_get_program_class(program_id, class_id, opts = {})
  data, _status_code, _headers = programs_controller_get_program_class_with_http_info(program_id, class_id, opts)
  data
end

#programs_controller_get_program_class_with_http_info(program_id, class_id, opts = {}) ⇒ Array<(EdApiModelsClass, Fixnum, Hash)>

Get a Courseware classes in a Courseware program by classId.

Parameters:

  • program_id —

    The ID of the program.

  • class_id —

    The ID of the class.

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

    the optional parameters

Returns:

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

    EdApiModelsClass data, response status code and response headers



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 961

def programs_controller_get_program_class_with_http_info(program_id, class_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.programs_controller_get_program_class ...'
  end
  # verify the required parameter 'program_id' is set
  if @api_client.config.client_side_validation && program_id.nil?
    fail ArgumentError, "Missing the required parameter 'program_id' when calling V20CoursewareApi.programs_controller_get_program_class"
  end
  # verify the required parameter 'class_id' is set
  if @api_client.config.client_side_validation && class_id.nil?
    fail ArgumentError, "Missing the required parameter 'class_id' when calling V20CoursewareApi.programs_controller_get_program_class"
  end
  # resource path
  local_var_path = '/courseware/v2.0/programs/{programId}/classes/{classId}'.sub('{' + 'programId' + '}', program_id.to_s).sub('{' + 'classId' + '}', class_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', 'text/json'])

  # form parameters
  form_params = {}

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

#programs_controller_get_program_classes(programid, pagesize, opts = {}) ⇒ EdApiPageableResultsWithCountEdApiModelsClass

Get a list of Courseware classes in a Courseware program. <ul> <li>This dataset can be quite large so result sets are paged using $pagesize and $skip parameters.</li> <li>$pagesize represents the number of results to return in a request, with a maximum $pagesize of 10000.</li> <li>If no $skip is provided, the call will return the first page of the result set.</li> <li>The next set of records can be obtained by making a request to the value of the "Next" field returned in the response.</li> </ul>
For example:</br> <ul> <li>?$pagesize=10000&amp;$skip=10000 - get results from 10000 - 19999 (next 10000 records).</li> <li>"Next": "/courseware/v2.0/programs/programid/classes?$pagesize=10000&amp;$skip=10000"</li> </ul>

Parameters:

  • programid —

    The ID of the program.

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :name (String) —

    An optional class name to filter by.

  • :after_start_date (DateTime)

Returns:



1011
1012
1013
1014
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1011

def programs_controller_get_program_classes(programid, pagesize, opts = {})
  data, _status_code, _headers = programs_controller_get_program_classes_with_http_info(programid, pagesize, opts)
  data
end

#programs_controller_get_program_classes_with_http_info(programid, pagesize, opts = {}) ⇒ Array<(EdApiPageableResultsWithCountEdApiModelsClass, Fixnum, Hash)>

Get a list of Courseware classes in a Courseware program. &lt;ul&gt; &lt;li&gt;This dataset can be quite large so result sets are paged using $pagesize and $skip parameters.&lt;/li&gt; &lt;li&gt;$pagesize represents the number of results to return in a request, with a maximum $pagesize of 10000.&lt;/li&gt; &lt;li&gt;If no $skip is provided, the call will return the first page of the result set.&lt;/li&gt; &lt;li&gt;The next set of records can be obtained by making a request to the value of the &quot;Next&quot; field returned in the response.&lt;/li&gt; &lt;/ul&gt; &lt;br&gt;For example:&lt;/br&gt; &lt;ul&gt; &lt;li&gt;?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000 - get results from 10000 - 19999 (next 10000 records).&lt;/li&gt; &lt;li&gt;&quot;Next&quot;: &quot;/courseware/v2.0/programs/programid/classes?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000&quot;&lt;/li&gt; &lt;/ul&gt;

Parameters:

  • programid —

    The ID of the program.

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :name (String) —

    An optional class name to filter by.

  • :after_start_date (DateTime)

Returns:



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1025

def programs_controller_get_program_classes_with_http_info(programid, pagesize, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.programs_controller_get_program_classes ...'
  end
  # verify the required parameter 'programid' is set
  if @api_client.config.client_side_validation && programid.nil?
    fail ArgumentError, "Missing the required parameter 'programid' when calling V20CoursewareApi.programs_controller_get_program_classes"
  end
  # verify the required parameter 'pagesize' is set
  if @api_client.config.client_side_validation && pagesize.nil?
    fail ArgumentError, "Missing the required parameter 'pagesize' when calling V20CoursewareApi.programs_controller_get_program_classes"
  end
  # resource path
  local_var_path = '/courseware/v2.0/programs/{programid}/classes'.sub('{' + 'programid' + '}', programid.to_s)

  # query parameters
  query_params = {}
  query_params[:'$pagesize'] = pagesize
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'afterStartDate'] = opts[:'after_start_date'] if !opts[:'after_start_date'].nil?

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

  # form parameters
  form_params = {}

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

#programs_controller_get_program_classes_with_user_ids(programid, pagesize, opts = {}) ⇒ EdApiPageableResultsWithCountEdApiModelsClassDetail

Gets a list of Courseware Classes (plus additional details) in a Courseware program.
This is very similar to GET /courseware/v2.0/programs/programid/classes, except that each class contains lists of UserIds for enrolled Teachers and Learners. </br> <ul> <li>This dataset can be quite large so result sets are paged using $pagesize and $skip parameters.</li> <li>$pagesize represents the number of results to return in a request, with a maximum $pagesize of 10000.</li> <li>If no $skip is provided, the call will return the first page of the result set.</li> <li>The next set of records can be obtained by making a request to the value of the "Next" field returned in the response.</li> </ul>
For example:</br> <ul> <li>?$pagesize=10000&amp;$skip=10000 - get results from 10000 - 19999 (next 10000 records).</li> <li>"Next": "/courseware/v2.0/programs/programid/classdetails?$pagesize=10000&amp;$skip=10000"</li> </ul>

Parameters:

  • programid —

    The ID of the program.

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :after_start_date (DateTime)

Returns:



1078
1079
1080
1081
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1078

def programs_controller_get_program_classes_with_user_ids(programid, pagesize, opts = {})
  data, _status_code, _headers = programs_controller_get_program_classes_with_user_ids_with_http_info(programid, pagesize, opts)
  data
end

#programs_controller_get_program_classes_with_user_ids_with_http_info(programid, pagesize, opts = {}) ⇒ Array<(EdApiPageableResultsWithCountEdApiModelsClassDetail, Fixnum, Hash)>

Gets a list of Courseware Classes (plus additional details) in a Courseware program. &lt;br&gt;This is very similar to GET /courseware/v2.0/programs/programid/classes, except that each class contains lists of UserIds for enrolled Teachers and Learners. &lt;/br&gt; &lt;ul&gt; &lt;li&gt;This dataset can be quite large so result sets are paged using $pagesize and $skip parameters.&lt;/li&gt; &lt;li&gt;$pagesize represents the number of results to return in a request, with a maximum $pagesize of 10000.&lt;/li&gt; &lt;li&gt;If no $skip is provided, the call will return the first page of the result set.&lt;/li&gt; &lt;li&gt;The next set of records can be obtained by making a request to the value of the &quot;Next&quot; field returned in the response.&lt;/li&gt; &lt;/ul&gt; &lt;br&gt;For example:&lt;/br&gt; &lt;ul&gt; &lt;li&gt;?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000 - get results from 10000 - 19999 (next 10000 records).&lt;/li&gt; &lt;li&gt;&quot;Next&quot;: &quot;/courseware/v2.0/programs/programid/classdetails?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000&quot;&lt;/li&gt; &lt;/ul&gt;

Parameters:

  • programid —

    The ID of the program.

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :after_start_date (DateTime)

Returns:



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1091

def programs_controller_get_program_classes_with_user_ids_with_http_info(programid, pagesize, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.programs_controller_get_program_classes_with_user_ids ...'
  end
  # verify the required parameter 'programid' is set
  if @api_client.config.client_side_validation && programid.nil?
    fail ArgumentError, "Missing the required parameter 'programid' when calling V20CoursewareApi.programs_controller_get_program_classes_with_user_ids"
  end
  # verify the required parameter 'pagesize' is set
  if @api_client.config.client_side_validation && pagesize.nil?
    fail ArgumentError, "Missing the required parameter 'pagesize' when calling V20CoursewareApi.programs_controller_get_program_classes_with_user_ids"
  end
  # resource path
  local_var_path = '/courseware/v2.0/programs/{programid}/classdetails'.sub('{' + 'programid' + '}', programid.to_s)

  # query parameters
  query_params = {}
  query_params[:'$pagesize'] = pagesize
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'afterStartDate'] = opts[:'after_start_date'] if !opts[:'after_start_date'].nil?

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

  # form parameters
  form_params = {}

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

#resource_nodes_controller_get_nodes(opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsResourceNode

Get a list of top level resource nodes for Plato and Custom Courses. Immediate children not returned.

Parameters:

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

    the optional parameters

Returns:



1138
1139
1140
1141
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1138

def resource_nodes_controller_get_nodes(opts = {})
  data, _status_code, _headers = resource_nodes_controller_get_nodes_with_http_info(opts)
  data
end

#resource_nodes_controller_get_nodes_with_http_info(opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsResourceNode, Fixnum, Hash)>

Get a list of top level resource nodes for Plato and Custom Courses. Immediate children not returned.

Parameters:

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

    the optional parameters

Returns:



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1146

def resource_nodes_controller_get_nodes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.resource_nodes_controller_get_nodes ...'
  end
  # resource path
  local_var_path = '/courseware/v2.0/resourcenodes'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#resource_nodes_controller_get_single_node(resourcenodeid, opts = {}) ⇒ EdApiModelsResourceNode

Get the list of immediate children of resourceNodeId provided.

Parameters:

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

    the optional parameters

Returns:



1183
1184
1185
1186
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1183

def resource_nodes_controller_get_single_node(resourcenodeid, opts = {})
  data, _status_code, _headers = resource_nodes_controller_get_single_node_with_http_info(resourcenodeid, opts)
  data
end

#resource_nodes_controller_get_single_node_with_http_info(resourcenodeid, opts = {}) ⇒ Array<(EdApiModelsResourceNode, Fixnum, Hash)>

Get the list of immediate children of resourceNodeId provided.

Parameters:

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

    the optional parameters

Returns:

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

    EdApiModelsResourceNode data, response status code and response headers



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
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'lib/edmentum_client/api/v20_courseware_api.rb', line 1192

def resource_nodes_controller_get_single_node_with_http_info(resourcenodeid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20CoursewareApi.resource_nodes_controller_get_single_node ...'
  end
  # verify the required parameter 'resourcenodeid' is set
  if @api_client.config.client_side_validation && resourcenodeid.nil?
    fail ArgumentError, "Missing the required parameter 'resourcenodeid' when calling V20CoursewareApi.resource_nodes_controller_get_single_node"
  end
  # resource path
  local_var_path = '/courseware/v2.0/resourcenodes/{resourcenodeid}'.sub('{' + 'resourcenodeid' + '}', resourcenodeid.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', 'text/json'])

  # form parameters
  form_params = {}

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