Class: OneRosterClient::EnrollmentsManagementApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EnrollmentsManagementApi

Returns a new instance of EnrollmentsManagementApi.



16
17
18
 
# File 'lib/oneroster_client/api/enrollments_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/enrollments_management_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_enrollment(sourced_id, opts = {}) ⇒ SingleEnrollmentType

The REST read request message for the getEnrollment() 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/enrollments_management_api.rb', line 24

def get_enrollment(sourced_id, opts = {})
  data, _status_code, _headers = get_enrollment_with_http_info(sourced_id, opts)
  data
end

#get_enrollment_with_http_info(sourced_id, opts = {}) ⇒ Array<(SingleEnrollmentType, Integer, Hash)>

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

Parameters:

  • sourced_id —

    …tbd…

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

    the optional parameters

Returns:

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

    SingleEnrollmentType 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/enrollments_management_api.rb', line 34

def get_enrollment_with_http_info(sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnrollmentsManagementApi.get_enrollment ...'
  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 EnrollmentsManagementApi.get_enrollment"
  end
  # resource path
  local_var_path = '/enrollments/{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] || 'SingleEnrollmentType' 

  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: EnrollmentsManagementApi#get_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_enrollments(opts = {}) ⇒ EnrollmentsType

The REST read request message for the getEnrollments() 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/enrollments_management_api.rb', line 86

def get_enrollments(opts = {})
  data, _status_code, _headers = get_enrollments_with_http_info(opts)
  data
end

#get_enrollments_for_class_in_school(school_sourced_id, class_sourced_id, opts = {}) ⇒ EnrollmentsType

The REST read request message for the getEnrollmentsForClassInSchool() 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:



162
163
164
165
 
# File 'lib/oneroster_client/api/enrollments_management_api.rb', line 162

def get_enrollments_for_class_in_school(school_sourced_id, class_sourced_id, opts = {})
  data, _status_code, _headers = get_enrollments_for_class_in_school_with_http_info(school_sourced_id, class_sourced_id, opts)
  data
end

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

The REST read request message for the getEnrollmentsForClassInSchool() 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<(EnrollmentsType, Integer, Hash)>) —

    EnrollmentsType data, response status code and response headers



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
229
230
231
232
233
234
 
# File 'lib/oneroster_client/api/enrollments_management_api.rb', line 180

def get_enrollments_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: EnrollmentsManagementApi.get_enrollments_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 EnrollmentsManagementApi.get_enrollments_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 EnrollmentsManagementApi.get_enrollments_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}/enrollments'.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] || 'EnrollmentsType' 

  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: EnrollmentsManagementApi#get_enrollments_for_class_in_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_enrollments_for_school(school_sourced_id, opts = {}) ⇒ EnrollmentsType

The REST read request message for the getEnrollmentsForSchool() 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:



247
248
249
250
 
# File 'lib/oneroster_client/api/enrollments_management_api.rb', line 247

def get_enrollments_for_school(school_sourced_id, opts = {})
  data, _status_code, _headers = get_enrollments_for_school_with_http_info(school_sourced_id, opts)
  data
end

#get_enrollments_for_school_with_http_info(school_sourced_id, opts = {}) ⇒ Array<(EnrollmentsType, Integer, Hash)>

The REST read request message for the getEnrollmentsForSchool() 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<(EnrollmentsType, Integer, Hash)>) —

    EnrollmentsType data, response status code and response headers



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/enrollments_management_api.rb', line 264

def get_enrollments_for_school_with_http_info(school_sourced_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnrollmentsManagementApi.get_enrollments_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 EnrollmentsManagementApi.get_enrollments_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}/enrollments'.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] || 'EnrollmentsType' 

  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: EnrollmentsManagementApi#get_enrollments_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_enrollments_with_http_info(opts = {}) ⇒ Array<(EnrollmentsType, Integer, Hash)>

The REST read request message for the getEnrollments() 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<(EnrollmentsType, Integer, Hash)>) —

    EnrollmentsType 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/enrollments_management_api.rb', line 102

def get_enrollments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnrollmentsManagementApi.get_enrollments ...'
  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 = '/enrollments'

  # 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] || 'EnrollmentsType' 

  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: EnrollmentsManagementApi#get_enrollments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end