Class: OneRosterClient::TermsManagementApi
- Inherits:
-
Object
- Object
- OneRosterClient::TermsManagementApi
- Defined in:
- lib/oneroster_client/api/terms_management_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_term(sourced_id, opts = {}) ⇒ SingleAcademicSessionType
The REST read request message for the getTerm() API call.
-
#get_term_with_http_info(sourced_id, opts = {}) ⇒ Array<(SingleAcademicSessionType, Integer, Hash)>
The REST read request message for the getTerm() API call.
-
#get_terms(opts = {}) ⇒ MultipleAcademicSessionsType
The REST read request message for the getTerms() API call.
-
#get_terms_for_school(school_sourced_id, opts = {}) ⇒ MultipleAcademicSessionsType
The REST read request message for the getTermsForSchool() API call.
-
#get_terms_for_school_with_http_info(school_sourced_id, opts = {}) ⇒ Array<(MultipleAcademicSessionsType, Integer, Hash)>
The REST read request message for the getTermsForSchool() API call.
-
#get_terms_with_http_info(opts = {}) ⇒ Array<(MultipleAcademicSessionsType, Integer, Hash)>
The REST read request message for the getTerms() API call.
-
#initialize(api_client = ApiClient.default) ⇒ TermsManagementApi
constructor
A new instance of TermsManagementApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TermsManagementApi
Returns a new instance of TermsManagementApi.
16 17 18 |
# File 'lib/oneroster_client/api/terms_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/terms_management_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#get_term(sourced_id, opts = {}) ⇒ SingleAcademicSessionType
The REST read request message for the getTerm() API call. …not supplied…
24 25 26 27 |
# File 'lib/oneroster_client/api/terms_management_api.rb', line 24 def get_term(sourced_id, opts = {}) data, _status_code, _headers = get_term_with_http_info(sourced_id, opts) data end |
#get_term_with_http_info(sourced_id, opts = {}) ⇒ Array<(SingleAcademicSessionType, Integer, Hash)>
The REST read request message for the getTerm() API call. …not supplied…
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/terms_management_api.rb', line 34 def get_term_with_http_info(sourced_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TermsManagementApi.get_term ...' 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 TermsManagementApi.get_term" end # resource path local_var_path = '/terms/{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] || 'SingleAcademicSessionType' 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: TermsManagementApi#get_term\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_terms(opts = {}) ⇒ MultipleAcademicSessionsType
The REST read request message for the getTerms() API call. …not supplied…
86 87 88 89 |
# File 'lib/oneroster_client/api/terms_management_api.rb', line 86 def get_terms(opts = {}) data, _status_code, _headers = get_terms_with_http_info(opts) data end |
#get_terms_for_school(school_sourced_id, opts = {}) ⇒ MultipleAcademicSessionsType
The REST read request message for the getTermsForSchool() API call. …not supplied…
161 162 163 164 |
# File 'lib/oneroster_client/api/terms_management_api.rb', line 161 def get_terms_for_school(school_sourced_id, opts = {}) data, _status_code, _headers = get_terms_for_school_with_http_info(school_sourced_id, opts) data end |
#get_terms_for_school_with_http_info(school_sourced_id, opts = {}) ⇒ Array<(MultipleAcademicSessionsType, Integer, Hash)>
The REST read request message for the getTermsForSchool() API call. …not supplied…
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/terms_management_api.rb', line 178 def get_terms_for_school_with_http_info(school_sourced_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TermsManagementApi.get_terms_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 TermsManagementApi.get_terms_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}/terms'.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] || 'MultipleAcademicSessionsType' 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: TermsManagementApi#get_terms_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_terms_with_http_info(opts = {}) ⇒ Array<(MultipleAcademicSessionsType, Integer, Hash)>
The REST read request message for the getTerms() API call. …not supplied…
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/terms_management_api.rb', line 102 def get_terms_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TermsManagementApi.get_terms ...' 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 = '/terms' # 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] || 'MultipleAcademicSessionsType' 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: TermsManagementApi#get_terms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |