Class: EdmentumClient::V20ExactPathApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V20ExactPathApi

Returns a new instance of V20ExactPathApi.



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

def api_client
  @api_client
end

Instance Method Details

#classes_controller_create_exact_path_class(model, opts = {}) ⇒ EdApiModelsExactPathClass

Create a new Exact Path Class

Parameters:

  • model —

    The model for the class to be created. <br />ClassGrade, ClassExpirationDate, CloseoutReminderDate and Location are optional. <br />AllowSelfEnrollment is optional and will default to false. <br />Program ID is ignored during class creation <br />At least one instructor ID is required. <br />Learners are optional.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 26

def classes_controller_create_exact_path_class(model, opts = {})
  data, _status_code, _headers = classes_controller_create_exact_path_class_with_http_info(model, opts)
  data
end

#classes_controller_create_exact_path_class_with_http_info(model, opts = {}) ⇒ Array<(EdApiModelsExactPathClass, Fixnum, Hash)>

Create a new Exact Path Class

Parameters:

  • model —

    The model for the class to be created. &lt;br /&gt;ClassGrade, ClassExpirationDate, CloseoutReminderDate and Location are optional. &lt;br /&gt;AllowSelfEnrollment is optional and will default to false. &lt;br /&gt;Program ID is ignored during class creation &lt;br /&gt;At least one instructor ID is required. &lt;br /&gt;Learners are optional.

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

    the optional parameters

Returns:

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

    EdApiModelsExactPathClass data, response status code and response headers



35
36
37
38
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
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 35

def classes_controller_create_exact_path_class_with_http_info(model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_create_exact_path_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 V20ExactPathApi.classes_controller_create_exact_path_class"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes'

  # 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 => 'EdApiModelsExactPathClass')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20ExactPathApi#classes_controller_create_exact_path_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_delete_exact_path_class(class_id, opts = {}) ⇒ String

Delete a Exact Path Class by Class ID

Parameters:

  • class_id —

    The id of the class to delete. If class has active assignments, the class will be archived.

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

    the optional parameters

Returns:

  • (String) 


78
79
80
81
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 78

def classes_controller_delete_exact_path_class(class_id, opts = {})
  data, _status_code, _headers = classes_controller_delete_exact_path_class_with_http_info(class_id, opts)
  data
end

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

Delete a Exact Path Class by Class ID

Parameters:

  • class_id —

    The id of the class to delete. If class has active assignments, the class will be archived.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 87

def classes_controller_delete_exact_path_class_with_http_info(class_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_delete_exact_path_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 V20ExactPathApi.classes_controller_delete_exact_path_class"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes/{classId}'.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(: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: V20ExactPathApi#classes_controller_delete_exact_path_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_enroll_learner_in_class(class_id, learner_id, opts = {}) ⇒ String

Enroll learner into Exact Path Class

Parameters:

  • class_id —

    The id of the class to add the learner.

  • learner_id —

    The user ID of the learner to enroll in the class.

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

    the optional parameters

Returns:

  • (String) 


129
130
131
132
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 129

def classes_controller_enroll_learner_in_class(class_id, learner_id, opts = {})
  data, _status_code, _headers = classes_controller_enroll_learner_in_class_with_http_info(class_id, learner_id, opts)
  data
end

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

Enroll learner into Exact Path Class

Parameters:

  • class_id —

    The id of the class to add the learner.

  • learner_id —

    The user ID of the learner to enroll in the class.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 139

def classes_controller_enroll_learner_in_class_with_http_info(class_id, learner_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_enroll_learner_in_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 V20ExactPathApi.classes_controller_enroll_learner_in_class"
  end
  # verify the required parameter 'learner_id' is set
  if @api_client.config.client_side_validation && learner_id.nil?
    fail ArgumentError, "Missing the required parameter 'learner_id' when calling V20ExactPathApi.classes_controller_enroll_learner_in_class"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes/{classId}/user/{learnerId}'.sub('{' + 'classId' + '}', class_id.to_s).sub('{' + 'learnerId' + '}', learner_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(: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: V20ExactPathApi#classes_controller_enroll_learner_in_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_get_exact_path_class(class_id, opts = {}) ⇒ EdApiModelsExactPathClass

Get a Exact Path Class by Class ID

Parameters:

  • class_id —

    The id of the class to retrieve.

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

    the optional parameters

Returns:



184
185
186
187
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 184

def classes_controller_get_exact_path_class(class_id, opts = {})
  data, _status_code, _headers = classes_controller_get_exact_path_class_with_http_info(class_id, opts)
  data
end

#classes_controller_get_exact_path_class_learners(class_id, opts = {}) ⇒ Array<EdApiModelsExactPathClassLearner>

Get a simplified data set of learners enrolled in an Exact Path Class by Class ID. <ul> <li>Gender can be 0 (male) or 1 (female).</li> <li>Grade is 0-15 with 0 being kindergarten and 13-15 adult values that are invalid for learners.</li> <li>Birth date is date only so will always be 0’s for time.</li> </ul>

Parameters:

  • class_id —

    The Class ID

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

    the optional parameters

Returns:



235
236
237
238
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 235

def classes_controller_get_exact_path_class_learners(class_id, opts = {})
  data, _status_code, _headers = classes_controller_get_exact_path_class_learners_with_http_info(class_id, opts)
  data
end

#classes_controller_get_exact_path_class_learners_with_http_info(class_id, opts = {}) ⇒ Array<(Array<EdApiModelsExactPathClassLearner>, Fixnum, Hash)>

Get a simplified data set of learners enrolled in an Exact Path Class by Class ID. &lt;ul&gt; &lt;li&gt;Gender can be 0 (male) or 1 (female).&lt;/li&gt; &lt;li&gt;Grade is 0-15 with 0 being kindergarten and 13-15 adult values that are invalid for learners.&lt;/li&gt; &lt;li&gt;Birth date is date only so will always be 0&#39;s for time.&lt;/li&gt; &lt;/ul&gt;

Parameters:

  • class_id —

    The Class ID

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

    the optional parameters

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 245

def classes_controller_get_exact_path_class_learners_with_http_info(class_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_get_exact_path_class_learners ...'
  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 V20ExactPathApi.classes_controller_get_exact_path_class_learners"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes/{classId}/learners'.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 => 'Array<EdApiModelsExactPathClassLearner>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20ExactPathApi#classes_controller_get_exact_path_class_learners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_get_exact_path_class_with_http_info(class_id, opts = {}) ⇒ Array<(EdApiModelsExactPathClass, Fixnum, Hash)>

Get a Exact Path Class by Class ID

Parameters:

  • class_id —

    The id of the class to retrieve.

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

    the optional parameters

Returns:

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

    EdApiModelsExactPathClass data, response status code and response headers



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 193

def classes_controller_get_exact_path_class_with_http_info(class_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_get_exact_path_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 V20ExactPathApi.classes_controller_get_exact_path_class"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes/{classId}'.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 => 'EdApiModelsExactPathClass')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20ExactPathApi#classes_controller_get_exact_path_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_get_time_spent_in_learning_path(class_id, model, opts = {}) ⇒ EdApiModelsExactPathLearningPathProgressReport

Get the learning path progress report for a subject by date range for the current academic year.

Parameters:

  • class_id —

    The Class ID

  • model —

    The query model for the report containing the ID for the subject (Valid entries are: 5 &#x3D; Math, 4 &#x3D; Language Arts, 15 &#x3D; Reading.), &lt;br /&gt;the starting date for the report results and the the end date for the range of results.

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 287

def classes_controller_get_time_spent_in_learning_path(class_id, model, opts = {})
  data, _status_code, _headers = classes_controller_get_time_spent_in_learning_path_with_http_info(class_id, model, opts)
  data
end

#classes_controller_get_time_spent_in_learning_path_with_http_info(class_id, model, opts = {}) ⇒ Array<(EdApiModelsExactPathLearningPathProgressReport, Fixnum, Hash)>

Get the learning path progress report for a subject by date range for the current academic year.

Parameters:

  • class_id —

    The Class ID

  • model —

    The query model for the report containing the ID for the subject (Valid entries are: 5 &#x3D; Math, 4 &#x3D; Language Arts, 15 &#x3D; Reading.), &lt;br /&gt;the starting date for the report results and the the end date for the range of results.

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

    the optional parameters

Returns:



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 297

def classes_controller_get_time_spent_in_learning_path_with_http_info(class_id, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_get_time_spent_in_learning_path ...'
  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 V20ExactPathApi.classes_controller_get_time_spent_in_learning_path"
  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 V20ExactPathApi.classes_controller_get_time_spent_in_learning_path"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes/{classId}/learningpathprogress'.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(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 => 'EdApiModelsExactPathLearningPathProgressReport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20ExactPathApi#classes_controller_get_time_spent_in_learning_path\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_remove_learner_from_class(class_id, learner_id, opts = {}) ⇒ String

Remove a learner from a Exact Path Class

Parameters:

  • class_id —

    The id of the class.

  • learner_id —

    The user ID of the learner to remove from the class.

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

    the optional parameters

Returns:

  • (String) 


345
346
347
348
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 345

def classes_controller_remove_learner_from_class(class_id, learner_id, opts = {})
  data, _status_code, _headers = classes_controller_remove_learner_from_class_with_http_info(class_id, learner_id, opts)
  data
end

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

Remove a learner from a Exact Path Class

Parameters:

  • class_id —

    The id of the class.

  • learner_id —

    The user ID of the learner to remove from the class.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 355

def classes_controller_remove_learner_from_class_with_http_info(class_id, learner_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_remove_learner_from_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 V20ExactPathApi.classes_controller_remove_learner_from_class"
  end
  # verify the required parameter 'learner_id' is set
  if @api_client.config.client_side_validation && learner_id.nil?
    fail ArgumentError, "Missing the required parameter 'learner_id' when calling V20ExactPathApi.classes_controller_remove_learner_from_class"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes/{classId}/user/{learnerId}'.sub('{' + 'classId' + '}', class_id.to_s).sub('{' + 'learnerId' + '}', learner_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(: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: V20ExactPathApi#classes_controller_remove_learner_from_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#classes_controller_update_exact_path_class(model, opts = {}) ⇒ EdApiModelsExactPathClass

Update Exact Path Class

Parameters:

  • model —

    The model for the class to be created. &lt;br /&gt;ClassId is required. &lt;br /&gt;ClassGrade, ClassExpirationDate, CloseoutReminderDate and Location are optional. &lt;br /&gt;AllowSelfEnrollment is optional and will default to false. &lt;br /&gt;Program ID is ignored during class creation &lt;br /&gt;At least one instructor ID is required. &lt;br /&gt;Learners are optional.

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

    the optional parameters

Returns:



400
401
402
403
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 400

def classes_controller_update_exact_path_class(model, opts = {})
  data, _status_code, _headers = classes_controller_update_exact_path_class_with_http_info(model, opts)
  data
end

#classes_controller_update_exact_path_class_with_http_info(model, opts = {}) ⇒ Array<(EdApiModelsExactPathClass, Fixnum, Hash)>

Update Exact Path Class

Parameters:

  • model —

    The model for the class to be created. &lt;br /&gt;ClassId is required. &lt;br /&gt;ClassGrade, ClassExpirationDate, CloseoutReminderDate and Location are optional. &lt;br /&gt;AllowSelfEnrollment is optional and will default to false. &lt;br /&gt;Program ID is ignored during class creation &lt;br /&gt;At least one instructor ID is required. &lt;br /&gt;Learners are optional.

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

    the optional parameters

Returns:

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

    EdApiModelsExactPathClass data, response status code and response headers



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/edmentum_client/api/v20_exact_path_api.rb', line 409

def classes_controller_update_exact_path_class_with_http_info(model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20ExactPathApi.classes_controller_update_exact_path_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 V20ExactPathApi.classes_controller_update_exact_path_class"
  end
  # resource path
  local_var_path = '/exactpath/v2.0/classes'

  # 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 => 'EdApiModelsExactPathClass')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20ExactPathApi#classes_controller_update_exact_path_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end