Class: EdmentumClient::V20AdministrationCenterApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ V20AdministrationCenterApi

Returns a new instance of V20AdministrationCenterApi.



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

def api_client
  @api_client
end

Instance Method Details

#alerts_controller_get_alert_summary_for_program(program_id, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsUserProgramAlertSummary

Get number of Mastery Test locks, items ready to score, and new message alerts. Number of alerts returned is by instructor per program.
</br> Optionally, specific userIds can be given as a query string parameter to only get counts for those users. Count of messages and announcements are for all programs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_ids (Array<Integer>)

Returns:



28
29
30
31
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 28

def alerts_controller_get_alert_summary_for_program(program_id, opts = {})
  data, _status_code, _headers = alerts_controller_get_alert_summary_for_program_with_http_info(program_id, opts)
  data
end

#alerts_controller_get_alert_summary_for_program_with_http_info(program_id, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsUserProgramAlertSummary, Fixnum, Hash)>

Get number of Mastery Test locks, items ready to score, and new message alerts. Number of alerts returned is by instructor per program. &lt;br&gt;&lt;/br&gt; Optionally, specific userIds can be given as a query string parameter to only get counts for those users. Count of messages and announcements are for all programs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :user_ids (Array<Integer>)

Returns:



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

def alerts_controller_get_alert_summary_for_program_with_http_info(program_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.alerts_controller_get_alert_summary_for_program ...'
  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 V20AdministrationCenterApi.alerts_controller_get_alert_summary_for_program"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/alerts/{programId}/summary'.sub('{' + 'programId' + '}', program_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'userIds'] = @api_client.build_collection_param(opts[:'user_ids'], :multi) if !opts[:'user_ids'].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 => 'EdApiModelsResultsWithCountEdApiModelsUserProgramAlertSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#alerts_controller_get_alert_summary_for_program\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#locations_controller_get_locations(opts = {}) ⇒ EdApiModelsLocationStructure

Get the list of locations the user has access to.

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 80

def locations_controller_get_locations(opts = {})
  data, _status_code, _headers = locations_controller_get_locations_with_http_info(opts)
  data
end

#locations_controller_get_locations_with_http_info(opts = {}) ⇒ Array<(EdApiModelsLocationStructure, Fixnum, Hash)>

Get the list of locations the user has access to.

Parameters:

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

    the optional parameters

Returns:



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

def locations_controller_get_locations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.locations_controller_get_locations ...'
  end
  # resource path
  local_var_path = '/admincenter/v2.0/locations'

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

#messages_controller_get_messages(pagesize, opts = {}) ⇒ EdApiPageableResultsWithCountEdApiModelsMessage

Get messages for account on or after a certain startDate <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;startDate=1/1/2021 - get results from 10000 - 19999 (next 10000 records).</li> <li>"Next": "/admincenter/v2.0/messages?$pagesize=10000&amp;$skip=10000&amp;startDate=1/1/2021"</li> </ul>

Parameters:

  • pagesize (Required) —

    Number of results to return in a request, with a maximum page size of 10000

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :start_date (DateTime) —

    Optional Start Date, when provided all messages on or after this date will be included in result set

Returns:



128
129
130
131
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 128

def messages_controller_get_messages(pagesize, opts = {})
  data, _status_code, _headers = messages_controller_get_messages_with_http_info(pagesize, opts)
  data
end

#messages_controller_get_messages_with_http_info(pagesize, opts = {}) ⇒ Array<(EdApiPageableResultsWithCountEdApiModelsMessage, Fixnum, Hash)>

Get messages for account on or after a certain startDate &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;startDate&#x3D;1/1/2021 - get results from 10000 - 19999 (next 10000 records).&lt;/li&gt; &lt;li&gt;&quot;Next&quot;: &quot;/admincenter/v2.0/messages?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000&amp;amp;startDate&#x3D;1/1/2021&quot;&lt;/li&gt; &lt;/ul&gt;

Parameters:

  • pagesize (Required) —

    Number of results to return in a request, with a maximum page size of 10000

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :start_date (DateTime) —

    Optional Start Date, when provided all messages on or after this date will be included in result set

Returns:



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_administration_center_api.rb', line 140

def messages_controller_get_messages_with_http_info(pagesize, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.messages_controller_get_messages ...'
  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 V20AdministrationCenterApi.messages_controller_get_messages"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/messages'

  # query parameters
  query_params = {}
  query_params[:'$pagesize'] = pagesize
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'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 => 'EdApiPageableResultsWithCountEdApiModelsMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#messages_controller_get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#programs_controller_get_programs(opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsProgram

Get the list of programs the user has access to.

Parameters:

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

    the optional parameters

Returns:



183
184
185
186
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 183

def programs_controller_get_programs(opts = {})
  data, _status_code, _headers = programs_controller_get_programs_with_http_info(opts)
  data
end

#programs_controller_get_programs_with_http_info(opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsProgram, Fixnum, Hash)>

Get the list of programs the user has access to.

Parameters:

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

    the optional parameters

Returns:



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

def programs_controller_get_programs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.programs_controller_get_programs ...'
  end
  # resource path
  local_var_path = '/admincenter/v2.0/programs'

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

#programs_controller_update_user_program_access(programid, userid, access_type, opts = {}) ⇒ String

Update program access type for a user.

Parameters:

  • programid
  • userid
  • access_type —

    Possible values for access type: &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;None&lt;/li&gt;&lt;li&gt;ProgramAdministrator&lt;/li&gt;&lt;li&gt;Teacher&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:

  • (String) 


230
231
232
233
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 230

def programs_controller_update_user_program_access(programid, userid, access_type, opts = {})
  data, _status_code, _headers = programs_controller_update_user_program_access_with_http_info(programid, userid, access_type, opts)
  data
end

#programs_controller_update_user_program_access_with_http_info(programid, userid, access_type, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update program access type for a user.

Parameters:

  • programid
  • userid
  • access_type —

    Possible values for access type: &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;None&lt;/li&gt;&lt;li&gt;ProgramAdministrator&lt;/li&gt;&lt;li&gt;Teacher&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



241
242
243
244
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
282
283
284
285
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 241

def programs_controller_update_user_program_access_with_http_info(programid, userid, access_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.programs_controller_update_user_program_access ...'
  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 V20AdministrationCenterApi.programs_controller_update_user_program_access"
  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 V20AdministrationCenterApi.programs_controller_update_user_program_access"
  end
  # verify the required parameter 'access_type' is set
  if @api_client.config.client_side_validation && access_type.nil?
    fail ArgumentError, "Missing the required parameter 'access_type' when calling V20AdministrationCenterApi.programs_controller_update_user_program_access"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/programs/{programid}/users/{userid}/{accessType}'.sub('{' + 'programid' + '}', programid.to_s).sub('{' + 'userid' + '}', userid.to_s).sub('{' + 'accessType' + '}', access_type.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(: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: V20AdministrationCenterApi#programs_controller_update_user_program_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#time_on_system_controller_user_time_on_system(start_date, pagesize, opts = {}) ⇒ EdApiPageableResultsWithCountEdCoreDomainReportingUserTimeOnSystem

Get TimeOnSystem data for account on or after a certain startDate <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;startDate=1/1/2021 - get results from 10000 - 19999 (next 10000 records).</li> <li>"Next": "/admincenter/v2.0/timeonsystem?$pagesize=10000&amp;$skip=10000&amp;startDate=1/1/2021"</li> </ul>

Parameters:

  • start_date (Required) —

    All usage data occurring on or after this date will be included in the result set

  • pagesize (Required) —

    Number of results to return in a request, with a maximum page size of 10000

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)

Returns:



293
294
295
296
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 293

def time_on_system_controller_user_time_on_system(start_date, pagesize, opts = {})
  data, _status_code, _headers = time_on_system_controller_user_time_on_system_with_http_info(start_date, pagesize, opts)
  data
end

#time_on_system_controller_user_time_on_system_with_http_info(start_date, pagesize, opts = {}) ⇒ Array<(EdApiPageableResultsWithCountEdCoreDomainReportingUserTimeOnSystem, Fixnum, Hash)>

Get TimeOnSystem data for account on or after a certain startDate &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;startDate&#x3D;1/1/2021 - get results from 10000 - 19999 (next 10000 records).&lt;/li&gt; &lt;li&gt;&quot;Next&quot;: &quot;/admincenter/v2.0/timeonsystem?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000&amp;amp;startDate&#x3D;1/1/2021&quot;&lt;/li&gt; &lt;/ul&gt;

Parameters:

  • start_date (Required) —

    All usage data occurring on or after this date will be included in the result set

  • pagesize (Required) —

    Number of results to return in a request, with a maximum page size of 10000

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)

Returns:



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
340
341
342
343
344
345
346
347
348
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 305

def time_on_system_controller_user_time_on_system_with_http_info(start_date, pagesize, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.time_on_system_controller_user_time_on_system ...'
  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 V20AdministrationCenterApi.time_on_system_controller_user_time_on_system"
  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 V20AdministrationCenterApi.time_on_system_controller_user_time_on_system"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/timeonsystem'

  # query parameters
  query_params = {}
  query_params[:'startDate'] = start_date
  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 => 'EdApiPageableResultsWithCountEdCoreDomainReportingUserTimeOnSystem')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#time_on_system_controller_user_time_on_system\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_add_user_to_location(userid, locationid, opts = {}) ⇒ String

Add a user to a location.

Parameters:

  • userid —

    The user id.

  • locationid —

    The location id.

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

    the optional parameters

Returns:

  • (String) 


354
355
356
357
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 354

def users_controller_add_user_to_location(userid, locationid, opts = {})
  data, _status_code, _headers = users_controller_add_user_to_location_with_http_info(userid, locationid, opts)
  data
end

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

Add a user to a location.

Parameters:

  • userid —

    The user id.

  • locationid —

    The location id.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
396
397
398
399
400
401
402
403
404
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 364

def users_controller_add_user_to_location_with_http_info(userid, locationid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_add_user_to_location ...'
  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 V20AdministrationCenterApi.users_controller_add_user_to_location"
  end
  # verify the required parameter 'locationid' is set
  if @api_client.config.client_side_validation && locationid.nil?
    fail ArgumentError, "Missing the required parameter 'locationid' when calling V20AdministrationCenterApi.users_controller_add_user_to_location"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/locations/{locationid}'.sub('{' + 'userid' + '}', userid.to_s).sub('{' + 'locationid' + '}', locationid.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(: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: V20AdministrationCenterApi#users_controller_add_user_to_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_create_family_contact(userid, family_contact_learner, opts = {}) ⇒ EdApiModelsFamilyContactLearner

Create family contact and link to a learner.

Parameters:

  • userid —

    Learner userId to link to new family contact.

  • family_contact_learner —

    Family contact user to create plus learner relationship details. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;FirstName, LastName - family contact name, required&lt;/li&gt;&lt;li&gt;EmailAddress - family contact email address, required and unique - used as family contact UserName&lt;/li&gt;&lt;li&gt;Relationship - family contact relationship to learner, optional&lt;/li&gt;&lt;li&gt;OptOutOfEmails - flag indicating whether family contact should be opted out of emails from LMS (false by default); API is not sending emails to family contacts, this flag controls LMS functionality&lt;/li&gt;&lt;li&gt;Password - family contact password, required, must be at least 8 characters&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:



410
411
412
413
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 410

def users_controller_create_family_contact(userid, family_contact_learner, opts = {})
  data, _status_code, _headers = users_controller_create_family_contact_with_http_info(userid, family_contact_learner, opts)
  data
end

#users_controller_create_family_contact_with_http_info(userid, family_contact_learner, opts = {}) ⇒ Array<(EdApiModelsFamilyContactLearner, Fixnum, Hash)>

Create family contact and link to a learner.

Parameters:

  • userid —

    Learner userId to link to new family contact.

  • family_contact_learner —

    Family contact user to create plus learner relationship details. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;FirstName, LastName - family contact name, required&lt;/li&gt;&lt;li&gt;EmailAddress - family contact email address, required and unique - used as family contact UserName&lt;/li&gt;&lt;li&gt;Relationship - family contact relationship to learner, optional&lt;/li&gt;&lt;li&gt;OptOutOfEmails - flag indicating whether family contact should be opted out of emails from LMS (false by default); API is not sending emails to family contacts, this flag controls LMS functionality&lt;/li&gt;&lt;li&gt;Password - family contact password, required, must be at least 8 characters&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:



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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 420

def users_controller_create_family_contact_with_http_info(userid, family_contact_learner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_create_family_contact ...'
  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 V20AdministrationCenterApi.users_controller_create_family_contact"
  end
  # verify the required parameter 'family_contact_learner' is set
  if @api_client.config.client_side_validation && family_contact_learner.nil?
    fail ArgumentError, "Missing the required parameter 'family_contact_learner' when calling V20AdministrationCenterApi.users_controller_create_family_contact"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/familycontacts'.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'])
  # 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(family_contact_learner)
  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 => 'EdApiModelsFamilyContactLearner')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#users_controller_create_family_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_create_user(user, opts = {}) ⇒ EdApiModelsUser

Create a new user.

Parameters:

  • user —

    The user to create. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;UserId is ignored on the create/POST request.&lt;/li&gt;&lt;li&gt;Possible values for Role: accountadministrator,programadministrator, teacher, learner&lt;/li&gt;&lt;li&gt;Possible values for grade are : [&#39;0&#39;, &#39;1&#39;, &#39;2&#39;, &#39;3&#39;, &#39;4&#39;, &#39;5&#39;, &#39;6&#39;, &#39;7&#39;, &#39;8&#39;, &#39;9&#39;, &#39;10&#39;, &#39;11&#39;, &#39;12&#39;, &#39;13&#39;, &#39;14&#39;, &#39;15&#39;]&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:



467
468
469
470
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 467

def users_controller_create_user(user, opts = {})
  data, _status_code, _headers = users_controller_create_user_with_http_info(user, opts)
  data
end

#users_controller_create_user_with_http_info(user, opts = {}) ⇒ Array<(EdApiModelsUser, Fixnum, Hash)>

Create a new user.

Parameters:

  • user —

    The user to create. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;UserId is ignored on the create/POST request.&lt;/li&gt;&lt;li&gt;Possible values for Role: accountadministrator,programadministrator, teacher, learner&lt;/li&gt;&lt;li&gt;Possible values for grade are : [&#39;0&#39;, &#39;1&#39;, &#39;2&#39;, &#39;3&#39;, &#39;4&#39;, &#39;5&#39;, &#39;6&#39;, &#39;7&#39;, &#39;8&#39;, &#39;9&#39;, &#39;10&#39;, &#39;11&#39;, &#39;12&#39;, &#39;13&#39;, &#39;14&#39;, &#39;15&#39;]&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsUser data, response status code and response headers



476
477
478
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
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 476

def users_controller_create_user_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_create_user ...'
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling V20AdministrationCenterApi.users_controller_create_user"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users'

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

#users_controller_delete_user(userid, opts = {}) ⇒ String

Delete a an existing user.

Parameters:

  • userid —

    The user id. &lt;br&gt; A learner can be deleted only if it was never enrolled in a class/assignment A teacher can be deleted on un-enrollment from all class/assignments &lt;/br&gt;

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

    the optional parameters

Returns:

  • (String) 


519
520
521
522
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 519

def users_controller_delete_user(userid, opts = {})
  data, _status_code, _headers = users_controller_delete_user_with_http_info(userid, opts)
  data
end

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

Delete a an existing user.

Parameters:

  • userid —

    The user id. &lt;br&gt; A learner can be deleted only if it was never enrolled in a class/assignment A teacher can be deleted on un-enrollment from all class/assignments &lt;/br&gt;

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



528
529
530
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
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 528

def users_controller_delete_user_with_http_info(userid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_delete_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 V20AdministrationCenterApi.users_controller_delete_user"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}'.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: V20AdministrationCenterApi#users_controller_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_get_learner_family_contacts(userid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsFamilyContactLearner

Get family contacts linked to a learner.
Passwords not returned in response for security reasons.</br>

Parameters:

  • userid —

    Learner userId.

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

    the optional parameters

Returns:



570
571
572
573
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 570

def users_controller_get_learner_family_contacts(userid, opts = {})
  data, _status_code, _headers = users_controller_get_learner_family_contacts_with_http_info(userid, opts)
  data
end

#users_controller_get_learner_family_contacts_with_http_info(userid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsFamilyContactLearner, Fixnum, Hash)>

Get family contacts linked to a learner. &lt;br&gt;Passwords not returned in response for security reasons.&lt;/br&gt;

Parameters:

  • userid —

    Learner userId.

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

    the optional parameters

Returns:



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 580

def users_controller_get_learner_family_contacts_with_http_info(userid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_get_learner_family_contacts ...'
  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 V20AdministrationCenterApi.users_controller_get_learner_family_contacts"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/familycontacts'.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(: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 => 'EdApiModelsResultsWithCountEdApiModelsFamilyContactLearner')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#users_controller_get_learner_family_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_get_single_user(userid, opts = {}) ⇒ EdApiModelsUser

Get a user by UserID.

Parameters:

  • userid —

    The user id. &lt;br&gt; Password will not be returned in response for security reasons. &lt;/br&gt;

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

    the optional parameters

Returns:



621
622
623
624
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 621

def users_controller_get_single_user(userid, opts = {})
  data, _status_code, _headers = users_controller_get_single_user_with_http_info(userid, opts)
  data
end

#users_controller_get_single_user_with_http_info(userid, opts = {}) ⇒ Array<(EdApiModelsUser, Fixnum, Hash)>

Get a user by UserID.

Parameters:

  • userid —

    The user id. &lt;br&gt; Password will not be returned in response for security reasons. &lt;/br&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsUser data, response status code and response headers



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 630

def users_controller_get_single_user_with_http_info(userid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_get_single_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 V20AdministrationCenterApi.users_controller_get_single_user"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}'.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(: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 => 'EdApiModelsUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#users_controller_get_single_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_get_user_locations(userid, opts = {}) ⇒ EdApiModelsResultsWithCountEdApiModelsLocation

Get a list of locations the user is added to.

Parameters:

  • userid —

    The user id.

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

    the optional parameters

Returns:



671
672
673
674
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 671

def users_controller_get_user_locations(userid, opts = {})
  data, _status_code, _headers = users_controller_get_user_locations_with_http_info(userid, opts)
  data
end

#users_controller_get_user_locations_with_http_info(userid, opts = {}) ⇒ Array<(EdApiModelsResultsWithCountEdApiModelsLocation, Fixnum, Hash)>

Get a list of locations the user is added to.

Parameters:

  • userid —

    The user id.

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

    the optional parameters

Returns:



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
708
709
710
711
712
713
714
715
716
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 680

def users_controller_get_user_locations_with_http_info(userid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_get_user_locations ...'
  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 V20AdministrationCenterApi.users_controller_get_user_locations"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/locations'.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(: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 => 'EdApiModelsResultsWithCountEdApiModelsLocation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#users_controller_get_user_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_get_users(pagesize, opts = {}) ⇒ EdApiPageableResultsWithCountEdApiModelsUser

Get a list of users that the user can update or delete. <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": "/admincenter/v2.0/users?$pagesize=10000&amp;$skip=10000"</li> </ul>

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :sis_id (String) — default: Optional —

    Result set will be filtered down to users matching the supplied Student Information System Id (SisID)

Returns:



724
725
726
727
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 724

def users_controller_get_users(pagesize, opts = {})
  data, _status_code, _headers = users_controller_get_users_with_http_info(pagesize, opts)
  data
end

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

Get a list of users that the user can update or delete. &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;/admincenter/v2.0/users?$pagesize&#x3D;10000&amp;amp;$skip&#x3D;10000&quot;&lt;/li&gt; &lt;/ul&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (Integer)
  • :sis_id (String) — default: Optional —

    Result set will be filtered down to users matching the supplied Student Information System Id (SisID)

Returns:



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
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 736

def users_controller_get_users_with_http_info(pagesize, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_get_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 V20AdministrationCenterApi.users_controller_get_users"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users'

  # query parameters
  query_params = {}
  query_params[:'$pagesize'] = pagesize
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'sisId'] = opts[:'sis_id'] if !opts[:'sis_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 => 'EdApiPageableResultsWithCountEdApiModelsUser')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#users_controller_get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_password(userid, password, opts = {}) ⇒ String

Update password for a user.

Parameters:

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

    the optional parameters

Returns:

  • (String) 


781
782
783
784
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 781

def users_controller_password(userid, password, opts = {})
  data, _status_code, _headers = users_controller_password_with_http_info(userid, password, opts)
  data
end

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

Update password for a user.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
832
833
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 791

def users_controller_password_with_http_info(userid, password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_password ...'
  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 V20AdministrationCenterApi.users_controller_password"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling V20AdministrationCenterApi.users_controller_password"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/password'.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'])
  # 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(password)
  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: V20AdministrationCenterApi#users_controller_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_remove_user_from_location(userid, locationid, opts = {}) ⇒ String

Remove a user from a location.

Parameters:

  • userid —

    The user id.

  • locationid —

    The location id.

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

    the optional parameters

Returns:

  • (String) 


839
840
841
842
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 839

def users_controller_remove_user_from_location(userid, locationid, opts = {})
  data, _status_code, _headers = users_controller_remove_user_from_location_with_http_info(userid, locationid, opts)
  data
end

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

Remove a user from a location.

Parameters:

  • userid —

    The user id.

  • locationid —

    The location id.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def users_controller_remove_user_from_location_with_http_info(userid, locationid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_remove_user_from_location ...'
  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 V20AdministrationCenterApi.users_controller_remove_user_from_location"
  end
  # verify the required parameter 'locationid' is set
  if @api_client.config.client_side_validation && locationid.nil?
    fail ArgumentError, "Missing the required parameter 'locationid' when calling V20AdministrationCenterApi.users_controller_remove_user_from_location"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/locations/{locationid}'.sub('{' + 'userid' + '}', userid.to_s).sub('{' + 'locationid' + '}', locationid.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: V20AdministrationCenterApi#users_controller_remove_user_from_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_reset_family_contact_password(userid, familycontactid, password, opts = {}) ⇒ String

Reset family contact password.

Parameters:

  • userid —

    Learner userId.

  • familycontactid —

    Family contact id.

  • password —

    Family contact password, required, must be at least 8 characters.

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

    the optional parameters

Returns:

  • (String) 


896
897
898
899
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 896

def users_controller_reset_family_contact_password(userid, familycontactid, password, opts = {})
  data, _status_code, _headers = users_controller_reset_family_contact_password_with_http_info(userid, familycontactid, password, opts)
  data
end

#users_controller_reset_family_contact_password_with_http_info(userid, familycontactid, password, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Reset family contact password.

Parameters:

  • userid —

    Learner userId.

  • familycontactid —

    Family contact id.

  • password —

    Family contact password, required, must be at least 8 characters.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
946
947
948
949
950
951
952
953
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 907

def users_controller_reset_family_contact_password_with_http_info(userid, familycontactid, password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_reset_family_contact_password ...'
  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 V20AdministrationCenterApi.users_controller_reset_family_contact_password"
  end
  # verify the required parameter 'familycontactid' is set
  if @api_client.config.client_side_validation && familycontactid.nil?
    fail ArgumentError, "Missing the required parameter 'familycontactid' when calling V20AdministrationCenterApi.users_controller_reset_family_contact_password"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling V20AdministrationCenterApi.users_controller_reset_family_contact_password"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/familycontacts/{familycontactid}'.sub('{' + 'userid' + '}', userid.to_s).sub('{' + 'familycontactid' + '}', familycontactid.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(password)
  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: V20AdministrationCenterApi#users_controller_reset_family_contact_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_unlink_family_contact_learner(userid, familycontactid, opts = {}) ⇒ String

Unlink learner from family contact.

Parameters:

  • userid —

    Learner userId.

  • familycontactid —

    Family contact id.

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

    the optional parameters

Returns:

  • (String) 


959
960
961
962
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 959

def users_controller_unlink_family_contact_learner(userid, familycontactid, opts = {})
  data, _status_code, _headers = users_controller_unlink_family_contact_learner_with_http_info(userid, familycontactid, opts)
  data
end

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

Unlink learner from family contact.

Parameters:

  • userid —

    Learner userId.

  • familycontactid —

    Family contact id.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 969

def users_controller_unlink_family_contact_learner_with_http_info(userid, familycontactid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_unlink_family_contact_learner ...'
  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 V20AdministrationCenterApi.users_controller_unlink_family_contact_learner"
  end
  # verify the required parameter 'familycontactid' is set
  if @api_client.config.client_side_validation && familycontactid.nil?
    fail ArgumentError, "Missing the required parameter 'familycontactid' when calling V20AdministrationCenterApi.users_controller_unlink_family_contact_learner"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/familycontacts/{familycontactid}'.sub('{' + 'userid' + '}', userid.to_s).sub('{' + 'familycontactid' + '}', familycontactid.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: V20AdministrationCenterApi#users_controller_unlink_family_contact_learner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_update_family_contact(userid, family_contact_learner, opts = {}) ⇒ EdApiModelsFamilyContactLearner

Update family contact and / or link to a learner.

Parameters:

  • userid —

    Learner userId to link family contact to.

  • family_contact_learner —

    Family contact user to update plus learner relationship details. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;FirstName, LastName - family contact name, required&lt;/li&gt;&lt;li&gt;EmailAddress - family contact email address, required and unique - used as family contact UserName&lt;/li&gt;&lt;li&gt;Relationship - family contact relationship to learner, optional&lt;/li&gt;&lt;li&gt;OptOutOfEmails - flag indicating whether family contact should be opted out of emails from LMS (false by default); API is not sending emails to family contacts, this flag controls LMS functionality&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:



1015
1016
1017
1018
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 1015

def users_controller_update_family_contact(userid, family_contact_learner, opts = {})
  data, _status_code, _headers = users_controller_update_family_contact_with_http_info(userid, family_contact_learner, opts)
  data
end

#users_controller_update_family_contact_with_http_info(userid, family_contact_learner, opts = {}) ⇒ Array<(EdApiModelsFamilyContactLearner, Fixnum, Hash)>

Update family contact and / or link to a learner.

Parameters:

  • userid —

    Learner userId to link family contact to.

  • family_contact_learner —

    Family contact user to update plus learner relationship details. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;FirstName, LastName - family contact name, required&lt;/li&gt;&lt;li&gt;EmailAddress - family contact email address, required and unique - used as family contact UserName&lt;/li&gt;&lt;li&gt;Relationship - family contact relationship to learner, optional&lt;/li&gt;&lt;li&gt;OptOutOfEmails - flag indicating whether family contact should be opted out of emails from LMS (false by default); API is not sending emails to family contacts, this flag controls LMS functionality&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

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

def users_controller_update_family_contact_with_http_info(userid, family_contact_learner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_update_family_contact ...'
  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 V20AdministrationCenterApi.users_controller_update_family_contact"
  end
  # verify the required parameter 'family_contact_learner' is set
  if @api_client.config.client_side_validation && family_contact_learner.nil?
    fail ArgumentError, "Missing the required parameter 'family_contact_learner' when calling V20AdministrationCenterApi.users_controller_update_family_contact"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users/{userid}/familycontacts'.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'])
  # 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(family_contact_learner)
  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 => 'EdApiModelsFamilyContactLearner')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: V20AdministrationCenterApi#users_controller_update_family_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_controller_update_user(user, opts = {}) ⇒ EdApiModelsUser

Update an existing user (does not allow changing user’s password).

Parameters:

  • user —

    The user to update. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;UserId is required on the update/PUT request.&lt;/li&gt;&lt;li&gt;User passwords may be updated with a PUT request to: /admincenter/V2/users/userid/password&lt;/li&gt;&lt;li&gt;Possible values for Role: accountadministrator,programadministrator, teacher, learner &lt;/li&gt;&lt;li&gt;Possible values for Grade: [&#39;0&#39;, &#39;1&#39;, &#39;2&#39;, &#39;3&#39;, &#39;4&#39;, &#39;5&#39;, &#39;6&#39;, &#39;7&#39;, &#39;8&#39;, &#39;9&#39;, &#39;10&#39;, &#39;11&#39;, &#39;12&#39;, &#39;13&#39;, &#39;14&#39;, &#39;15&#39;]&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:



1072
1073
1074
1075
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 1072

def users_controller_update_user(user, opts = {})
  data, _status_code, _headers = users_controller_update_user_with_http_info(user, opts)
  data
end

#users_controller_update_user_with_http_info(user, opts = {}) ⇒ Array<(EdApiModelsUser, Fixnum, Hash)>

Update an existing user (does not allow changing user&#39;s password).

Parameters:

  • user —

    The user to update. &lt;ul style&#x3D;&quot;font-size: smaller;&quot;&gt;&lt;li&gt;UserId is required on the update/PUT request.&lt;/li&gt;&lt;li&gt;User passwords may be updated with a PUT request to: /admincenter/V2/users/userid/password&lt;/li&gt;&lt;li&gt;Possible values for Role: accountadministrator,programadministrator, teacher, learner &lt;/li&gt;&lt;li&gt;Possible values for Grade: [&#39;0&#39;, &#39;1&#39;, &#39;2&#39;, &#39;3&#39;, &#39;4&#39;, &#39;5&#39;, &#39;6&#39;, &#39;7&#39;, &#39;8&#39;, &#39;9&#39;, &#39;10&#39;, &#39;11&#39;, &#39;12&#39;, &#39;13&#39;, &#39;14&#39;, &#39;15&#39;]&lt;/li&gt;&lt;/ul&gt;

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

    the optional parameters

Returns:

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

    EdApiModelsUser data, response status code and response headers



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
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
 
# File 'lib/edmentum_client/api/v20_administration_center_api.rb', line 1081

def users_controller_update_user_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: V20AdministrationCenterApi.users_controller_update_user ...'
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling V20AdministrationCenterApi.users_controller_update_user"
  end
  # resource path
  local_var_path = '/admincenter/v2.0/users'

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