Class: School21::CampusesApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/school21/api/campuses_api.rb

Constant Summary

Constants inherited from BaseApi

BaseApi::PLATFORM_AUTH_PARTICIPANT

Instance Method Summary collapse

Methods inherited from BaseApi

base_uri, #execute_request, #initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, #request_with_auth_participant, response_convertor

Constructor Details

This class inherits a constructor from School21::BaseApi

Instance Method Details

#campus_clusters(campus_id) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/school21/api/campuses_api.rb', line 33

def campus_clusters(campus_id)
  path = ['/campuses/', campus_id, '/clusters'].join
  new_request = request_with_auth_participant(HttpMethod::GET, path, :api_v1)

  execute_request(new_request)
end

#campus_coalitions(campus_id, options: {}) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/school21/api/campuses_api.rb', line 21

def campus_coalitions(campus_id, options: {})
  path = ['/campuses/', campus_id, '/coalitions'].join
  default_options = { limit: 50, offset: 0 }.merge(options)
  new_request = request_with_auth_participant(HttpMethod::GET, path, :api_v1)

  default_options.each do |key, value|
    new_request.query_param(new_parameter(value, key:))
  end

  execute_request(new_request)
end

#campus_participants(campus_id, options: {}) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/school21/api/campuses_api.rb', line 9

def campus_participants(campus_id, options: {})
  path = ['/campuses/', campus_id, '/participants'].join
  default_options = { limit: 50, offset: 0 }.merge(options)
  new_request = request_with_auth_participant(HttpMethod::GET, path, :api_v1)

  default_options.each do |key, value|
    new_request.query_param(new_parameter(value, key:))
  end

  execute_request(new_request)
end

#campuses ⇒ Object 



5
6
7
 
# File 'lib/school21/api/campuses_api.rb', line 5

def campuses
  execute_request(request_with_auth_participant(HttpMethod::GET, '/campuses', :api_v1))
end