Class: OneRosterClient::StudentsManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/oneroster_client/api/students_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StudentsManagementApi

Returns a new instance of StudentsManagementApi.



16
17
18
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_student(sourced_id, opts = {}) ⇒ SingleUserType

The REST read request message for the getStudent() API call. …not supplied…

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 24

def get_student(sourced_id, opts = {})
  data, _status_code, _headers = get_student_with_http_info(sourced_id, opts)
  data
end

#get_student_with_http_info(sourced_id, opts = {}) ⇒ Array<(SingleUserType, Integer, Hash)>

The REST read request message for the getStudent() API call. …not supplied…

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

  • (Array<(SingleUserType, Integer, Hash)>) —

    SingleUserType data, response status code and response headers



34
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
74
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 34

def get_student_with_http_info(sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StudentsManagementApi.get_student ...'
  end
  # verify the required parameter 'sourced_id' is set
  if @api_client.config.client_side_validation && sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'sourced_id' when calling StudentsManagementApi.get_student"
  end
  # resource path
  local_var_path = '/students/{sourcedId}'.sub('{' + 'sourcedId' + '}', sourced_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'SingleUserType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StudentsManagementApi#get_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students(opts = {}) ⇒ UsersType

The REST read request message for the getStudents() API call. …not supplied…

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response. (default to 100)

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message. (default to 0)

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:



86
87
88
89
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 86

def get_students(opts = {})
  data, _status_code, _headers = get_students_with_http_info(opts)
  data
end

#get_students_for_class(class_sourced_id, opts = {}) ⇒ UsersType

The REST read request message for the getStudentsForClass() API call. …not supplied…

Parameters:

  • class_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response. (default to 100)

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message. (default to 0)

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:



161
162
163
164
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 161

def get_students_for_class(class_sourced_id, opts = {})
  data, _status_code, _headers = get_students_for_class_with_http_info(class_sourced_id, opts)
  data
end

#get_students_for_class_in_school(school_sourced_id, class_sourced_id, opts = {}) ⇒ UsersType

The REST read request message for the getStudentsForClassInSchool() API call. …not supplied…

Parameters:

  • school_sourced_id —

    …tbd…

  • class_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response. (default to 100)

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message. (default to 0)

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:



242
243
244
245
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 242

def get_students_for_class_in_school(school_sourced_id, class_sourced_id, opts = {})
  data, _status_code, _headers = get_students_for_class_in_school_with_http_info(school_sourced_id, class_sourced_id, opts)
  data
end

#get_students_for_class_in_school_with_http_info(school_sourced_id, class_sourced_id, opts = {}) ⇒ Array<(UsersType, Integer, Hash)>

The REST read request message for the getStudentsForClassInSchool() API call. …not supplied…

Parameters:

  • school_sourced_id —

    …tbd…

  • class_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response.

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message.

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:

  • (Array<(UsersType, Integer, Hash)>) —

    UsersType data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 260

def get_students_for_class_in_school_with_http_info(school_sourced_id, class_sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StudentsManagementApi.get_students_for_class_in_school ...'
  end
  # verify the required parameter 'school_sourced_id' is set
  if @api_client.config.client_side_validation && school_sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'school_sourced_id' when calling StudentsManagementApi.get_students_for_class_in_school"
  end
  # verify the required parameter 'class_sourced_id' is set
  if @api_client.config.client_side_validation && class_sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'class_sourced_id' when calling StudentsManagementApi.get_students_for_class_in_school"
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['acs', 'desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of acs, desc'
  end
  # resource path
  local_var_path = '/schools/{schoolSourcedId}/classes/{classSourcedId}/students'.sub('{' + 'schoolSourcedId' + '}', school_sourced_id.to_s).sub('{' + 'classSourcedId' + '}', class_sourced_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'continuationToken'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'UsersType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StudentsManagementApi#get_students_for_class_in_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_for_class_with_http_info(class_sourced_id, opts = {}) ⇒ Array<(UsersType, Integer, Hash)>

The REST read request message for the getStudentsForClass() API call. …not supplied…

Parameters:

  • class_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response.

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message.

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:

  • (Array<(UsersType, Integer, Hash)>) —

    UsersType data, response status code and response headers



178
179
180
181
182
183
184
185
186
187
188
189
190
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
224
225
226
227
228
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 178

def get_students_for_class_with_http_info(class_sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StudentsManagementApi.get_students_for_class ...'
  end
  # verify the required parameter 'class_sourced_id' is set
  if @api_client.config.client_side_validation && class_sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'class_sourced_id' when calling StudentsManagementApi.get_students_for_class"
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['acs', 'desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of acs, desc'
  end
  # resource path
  local_var_path = '/classes/{classSourcedId}/students'.sub('{' + 'classSourcedId' + '}', class_sourced_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'continuationToken'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'UsersType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StudentsManagementApi#get_students_for_class\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_for_school(school_sourced_id, opts = {}) ⇒ UsersType

The REST read request message for the getStudentsForSchool() API call. …not supplied…

Parameters:

  • school_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response. (default to 100)

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message. (default to 0)

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:



327
328
329
330
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 327

def get_students_for_school(school_sourced_id, opts = {})
  data, _status_code, _headers = get_students_for_school_with_http_info(school_sourced_id, opts)
  data
end

#get_students_for_school_with_http_info(school_sourced_id, opts = {}) ⇒ Array<(UsersType, Integer, Hash)>

The REST read request message for the getStudentsForSchool() API call. …not supplied…

Parameters:

  • school_sourced_id —

    …tbd…

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response.

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message.

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:

  • (Array<(UsersType, Integer, Hash)>) —

    UsersType data, response status code and response headers



344
345
346
347
348
349
350
351
352
353
354
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
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 344

def get_students_for_school_with_http_info(school_sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StudentsManagementApi.get_students_for_school ...'
  end
  # verify the required parameter 'school_sourced_id' is set
  if @api_client.config.client_side_validation && school_sourced_id.nil?
    fail ArgumentError, "Missing the required parameter 'school_sourced_id' when calling StudentsManagementApi.get_students_for_school"
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['acs', 'desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of acs, desc'
  end
  # resource path
  local_var_path = '/schools/{schoolSourcedId}/students'.sub('{' + 'schoolSourcedId' + '}', school_sourced_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'continuationToken'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'UsersType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StudentsManagementApi#get_students_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_students_with_http_info(opts = {}) ⇒ Array<(UsersType, Integer, Hash)>

The REST read request message for the getStudents() API call. …not supplied…

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    To define the download segmentation value i.e. the maximum number of records to be contained in the response.

  • :offset (Integer) —

    The number of the first record to be supplied in the segmented response message.

  • :continuation_token (String) —

    Allows the client to resume retrieving results from where the previous page left off

  • :sort (String) —

    Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

  • :order_by (String) —

    The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

  • :filter (String) —

    The filtering rules to be applied when identifying the records to be supplied in the response message.

  • :fields (Array<String>) —

    To identify the range of fields that should be supplied in the response message.

Returns:

  • (Array<(UsersType, Integer, Hash)>) —

    UsersType data, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oneroster_client/api/students_management_api.rb', line 102

def get_students_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StudentsManagementApi.get_students ...'
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['acs', 'desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of acs, desc'
  end
  # resource path
  local_var_path = '/students'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'continuationToken'] = opts[:'continuation_token'] if !opts[:'continuation_token'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'UsersType' 

  auth_names = opts[:auth_names] || ['OAuth2Security']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StudentsManagementApi#get_students\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end