clever-ruby 1.2.5 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/1.8, +0 -0
- data/= +0 -0
- data/CHANGELOG.md +3 -3
- data/Gemfile +0 -1
- data/Gemfile.lock +8 -9
- data/README.md +89 -70
- data/clever-ruby.gemspec +3 -4
- data/doc_coverage.txt +2 -0
- data/docs/{StudentContact.md → Contact.md} +2 -2
- data/docs/{GradeLevelsResponse.md → ContactObject.md} +2 -2
- data/docs/{StudentContactObject.md → ContactResponse.md} +2 -2
- data/docs/{StudentcontactsCreated.md → ContactsCreated.md} +2 -2
- data/docs/{StudentcontactsDeleted.md → ContactsDeleted.md} +2 -2
- data/docs/ContactsResponse.md +8 -0
- data/docs/{StudentcontactsUpdated.md → ContactsUpdated.md} +2 -2
- data/docs/Course.md +10 -0
- data/docs/{StudentContactResponse.md → CourseObject.md} +2 -2
- data/docs/CourseResponse.md +8 -0
- data/docs/CoursesCreated.md +11 -0
- data/docs/CoursesDeleted.md +11 -0
- data/docs/{StudentContactsForStudentResponse.md → CoursesResponse.md} +2 -2
- data/docs/CoursesUpdated.md +11 -0
- data/docs/DataApi.md +862 -182
- data/docs/District.md +8 -0
- data/docs/{DistrictStatusResponse.md → DistrictAdminObject.md} +2 -2
- data/docs/DistrictAdminsResponse.md +1 -1
- data/docs/DistrictadminsCreated.md +11 -0
- data/docs/DistrictadminsDeleted.md +11 -0
- data/docs/DistrictadminsUpdated.md +11 -0
- data/docs/EventsApi.md +6 -302
- data/docs/Section.md +2 -4
- data/docs/Term.md +1 -0
- data/docs/TermObject.md +8 -0
- data/docs/TermResponse.md +8 -0
- data/docs/TermsCreated.md +11 -0
- data/docs/TermsDeleted.md +11 -0
- data/docs/TermsResponse.md +8 -0
- data/docs/TermsUpdated.md +11 -0
- data/lib/clever-ruby.rb +26 -14
- data/lib/clever-ruby/api/data_api.rb +828 -132
- data/lib/clever-ruby/api/events_api.rb +8 -312
- data/lib/clever-ruby/api_client.rb +40 -27
- data/lib/clever-ruby/api_error.rb +2 -2
- data/lib/clever-ruby/configuration.rb +3 -3
- data/lib/clever-ruby/models/bad_request.rb +2 -2
- data/lib/clever-ruby/models/{student_contact.rb → contact.rb} +69 -10
- data/lib/clever-ruby/models/{student_contact_object.rb → contact_object.rb} +4 -4
- data/lib/clever-ruby/models/{student_contact_response.rb → contact_response.rb} +4 -4
- data/lib/clever-ruby/models/contacts_created.rb +221 -0
- data/lib/clever-ruby/models/contacts_deleted.rb +221 -0
- data/lib/clever-ruby/models/{student_contacts_response.rb → contacts_response.rb} +4 -4
- data/lib/clever-ruby/models/contacts_updated.rb +221 -0
- data/lib/clever-ruby/models/course.rb +206 -0
- data/lib/clever-ruby/models/course_object.rb +188 -0
- data/lib/clever-ruby/models/{district_status_response.rb → course_response.rb} +4 -4
- data/lib/clever-ruby/models/courses_created.rb +221 -0
- data/lib/clever-ruby/models/courses_deleted.rb +221 -0
- data/lib/clever-ruby/models/{district_status_responses.rb → courses_response.rb} +4 -4
- data/lib/clever-ruby/models/courses_updated.rb +221 -0
- data/lib/clever-ruby/models/credentials.rb +2 -2
- data/lib/clever-ruby/models/district.rb +111 -6
- data/lib/clever-ruby/models/district_admin.rb +2 -2
- data/lib/clever-ruby/models/district_admin_object.rb +188 -0
- data/lib/clever-ruby/models/district_admin_response.rb +2 -2
- data/lib/clever-ruby/models/district_admins_response.rb +3 -3
- data/lib/clever-ruby/models/district_object.rb +2 -2
- data/lib/clever-ruby/models/district_response.rb +2 -2
- data/lib/clever-ruby/models/districtadmins_created.rb +221 -0
- data/lib/clever-ruby/models/districtadmins_deleted.rb +221 -0
- data/lib/clever-ruby/models/districtadmins_updated.rb +221 -0
- data/lib/clever-ruby/models/districts_created.rb +22 -7
- data/lib/clever-ruby/models/districts_deleted.rb +22 -8
- data/lib/clever-ruby/models/districts_response.rb +2 -2
- data/lib/clever-ruby/models/districts_updated.rb +21 -7
- data/lib/clever-ruby/models/event.rb +2 -2
- data/lib/clever-ruby/models/event_response.rb +2 -2
- data/lib/clever-ruby/models/events_response.rb +2 -2
- data/lib/clever-ruby/models/internal_error.rb +2 -2
- data/lib/clever-ruby/models/location.rb +2 -2
- data/lib/clever-ruby/models/name.rb +2 -2
- data/lib/clever-ruby/models/not_found.rb +2 -2
- data/lib/clever-ruby/models/principal.rb +2 -2
- data/lib/clever-ruby/models/school.rb +2 -2
- data/lib/clever-ruby/models/school_admin.rb +2 -2
- data/lib/clever-ruby/models/school_admin_object.rb +2 -2
- data/lib/clever-ruby/models/school_admin_response.rb +2 -2
- data/lib/clever-ruby/models/school_admins_response.rb +2 -2
- data/lib/clever-ruby/models/school_object.rb +2 -2
- data/lib/clever-ruby/models/school_response.rb +2 -2
- data/lib/clever-ruby/models/schooladmins_created.rb +21 -7
- data/lib/clever-ruby/models/schooladmins_deleted.rb +21 -7
- data/lib/clever-ruby/models/schooladmins_updated.rb +21 -7
- data/lib/clever-ruby/models/schools_created.rb +21 -7
- data/lib/clever-ruby/models/schools_deleted.rb +21 -7
- data/lib/clever-ruby/models/schools_response.rb +2 -2
- data/lib/clever-ruby/models/schools_updated.rb +21 -7
- data/lib/clever-ruby/models/section.rb +15 -33
- data/lib/clever-ruby/models/section_object.rb +2 -2
- data/lib/clever-ruby/models/section_response.rb +2 -2
- data/lib/clever-ruby/models/sections_created.rb +21 -7
- data/lib/clever-ruby/models/sections_deleted.rb +21 -7
- data/lib/clever-ruby/models/sections_response.rb +2 -2
- data/lib/clever-ruby/models/sections_updated.rb +21 -7
- data/lib/clever-ruby/models/student.rb +4 -4
- data/lib/clever-ruby/models/student_object.rb +2 -2
- data/lib/clever-ruby/models/student_response.rb +2 -2
- data/lib/clever-ruby/models/students_created.rb +20 -7
- data/lib/clever-ruby/models/students_deleted.rb +22 -7
- data/lib/clever-ruby/models/students_response.rb +2 -2
- data/lib/clever-ruby/models/students_updated.rb +21 -7
- data/lib/clever-ruby/models/teacher.rb +2 -2
- data/lib/clever-ruby/models/teacher_object.rb +2 -2
- data/lib/clever-ruby/models/teacher_response.rb +2 -2
- data/lib/clever-ruby/models/teachers_created.rb +21 -7
- data/lib/clever-ruby/models/teachers_deleted.rb +21 -7
- data/lib/clever-ruby/models/teachers_response.rb +2 -2
- data/lib/clever-ruby/models/teachers_updated.rb +21 -7
- data/lib/clever-ruby/models/term.rb +12 -3
- data/lib/clever-ruby/models/term_object.rb +188 -0
- data/lib/clever-ruby/models/term_response.rb +188 -0
- data/lib/clever-ruby/models/{studentcontacts_updated.rb → terms_created.rb} +23 -9
- data/{override/models/studentcontacts_created.rb → lib/clever-ruby/models/terms_deleted.rb} +23 -9
- data/lib/clever-ruby/models/{grade_levels_response.rb → terms_response.rb} +4 -4
- data/lib/clever-ruby/models/{studentcontacts_created.rb → terms_updated.rb} +23 -9
- data/lib/clever-ruby/version.rb +3 -3
- data/override/README-extension.md +5 -5
- data/override/api_client.rb +40 -27
- data/override/models/contacts_created.rb +221 -0
- data/override/models/contacts_deleted.rb +221 -0
- data/override/models/contacts_updated.rb +221 -0
- data/override/models/courses_created.rb +221 -0
- data/override/models/courses_deleted.rb +221 -0
- data/override/models/courses_updated.rb +221 -0
- data/override/models/districtadmins_created.rb +221 -0
- data/override/models/districtadmins_deleted.rb +221 -0
- data/override/models/districtadmins_updated.rb +221 -0
- data/override/models/districts_created.rb +22 -7
- data/override/models/districts_deleted.rb +22 -8
- data/override/models/districts_updated.rb +21 -7
- data/override/models/schooladmins_created.rb +21 -7
- data/override/models/schooladmins_deleted.rb +21 -7
- data/override/models/schooladmins_updated.rb +21 -7
- data/override/models/schools_created.rb +21 -7
- data/override/models/schools_deleted.rb +21 -7
- data/override/models/schools_updated.rb +21 -7
- data/override/models/sections_created.rb +21 -7
- data/override/models/sections_deleted.rb +21 -7
- data/override/models/sections_updated.rb +21 -7
- data/override/models/students_created.rb +20 -7
- data/override/models/students_deleted.rb +22 -7
- data/override/models/students_updated.rb +21 -7
- data/override/models/teachers_created.rb +21 -7
- data/override/models/teachers_deleted.rb +21 -7
- data/override/models/teachers_updated.rb +21 -7
- data/{lib/clever-ruby/models/studentcontacts_deleted.rb → override/models/terms_created.rb} +23 -9
- data/override/models/terms_deleted.rb +221 -0
- data/override/models/terms_updated.rb +221 -0
- data/sample/sample.rb +2 -2
- data/spec/events_api_spec.rb +1 -1
- data/test.rb +1 -1
- metadata +111 -85
- data/clever-ruby-2.0.0.gem +0 -0
- data/docs/DistrictStatus.md +0 -15
- data/docs/DistrictStatusResponses.md +0 -8
- data/docs/StudentContactsResponse.md +0 -8
- data/lib/clever-ruby/models/district_status.rb +0 -284
- data/lib/clever-ruby/models/student_contacts_for_student_response.rb +0 -190
- data/override/models/studentcontacts_deleted.rb +0 -207
- data/override/models/studentcontacts_updated.rb +0 -207
- data/spec/data_api_spec.rb +0 -32
@@ -1,4 +1,4 @@
|
|
1
|
-
# Clever::
|
1
|
+
# Clever::ContactsUpdated
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**created** | **String** | | [optional]
|
7
7
|
**id** | **String** | | [optional]
|
8
8
|
**type** | **String** | |
|
9
|
-
**data** | [**
|
9
|
+
**data** | [**ContactObject**](ContactObject.md) | | [optional]
|
10
10
|
|
11
11
|
|
data/docs/Course.md
ADDED
@@ -1,8 +1,8 @@
|
|
1
|
-
# Clever::
|
1
|
+
# Clever::CourseObject
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**object** | [**Course**](Course.md) | | [optional]
|
7
7
|
|
8
8
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Clever::CoursesCreated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**type** | **String** | |
|
9
|
+
**data** | [**CourseObject**](CourseObject.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Clever::CoursesDeleted
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**type** | **String** | |
|
9
|
+
**data** | [**CourseObject**](CourseObject.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -1,8 +1,8 @@
|
|
1
|
-
# Clever::
|
1
|
+
# Clever::CoursesResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**data** | [**Array<
|
6
|
+
**data** | [**Array<CourseResponse>**](CourseResponse.md) | | [optional]
|
7
7
|
|
8
8
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Clever::CoursesUpdated
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**created** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**type** | **String** | |
|
9
|
+
**data** | [**CourseObject**](CourseObject.md) | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/DataApi.md
CHANGED
@@ -1,23 +1,28 @@
|
|
1
1
|
# Clever::DataApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://api.clever.com/
|
3
|
+
All URIs are relative to *https://api.clever.com/v2.0*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} |
|
8
8
|
[**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts |
|
9
9
|
[**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
|
10
|
+
[**get_course**](DataApi.md#get_course) | **GET** /courses/{id} |
|
11
|
+
[**get_course_for_section**](DataApi.md#get_course_for_section) | **GET** /sections/{id}/course |
|
12
|
+
[**get_courses**](DataApi.md#get_courses) | **GET** /courses |
|
10
13
|
[**get_district**](DataApi.md#get_district) | **GET** /districts/{id} |
|
11
14
|
[**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
|
12
15
|
[**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins |
|
16
|
+
[**get_district_for_contact**](DataApi.md#get_district_for_contact) | **GET** /contacts/{id}/district |
|
17
|
+
[**get_district_for_course**](DataApi.md#get_district_for_course) | **GET** /courses/{id}/district |
|
18
|
+
[**get_district_for_district_admin**](DataApi.md#get_district_for_district_admin) | **GET** /district_admins/{id}/district |
|
13
19
|
[**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
|
20
|
+
[**get_district_for_school_admin**](DataApi.md#get_district_for_school_admin) | **GET** /school_admins/{id}/district |
|
14
21
|
[**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
|
15
22
|
[**get_district_for_student**](DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
|
16
|
-
[**get_district_for_student_contact**](DataApi.md#get_district_for_student_contact) | **GET** /contacts/{id}/district |
|
17
23
|
[**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
|
18
|
-
[**
|
24
|
+
[**get_district_for_term**](DataApi.md#get_district_for_term) | **GET** /terms/{id}/district |
|
19
25
|
[**get_districts**](DataApi.md#get_districts) | **GET** /districts |
|
20
|
-
[**get_grade_levels_for_teacher**](DataApi.md#get_grade_levels_for_teacher) | **GET** /teachers/{id}/grade_levels |
|
21
26
|
[**get_school**](DataApi.md#get_school) | **GET** /schools/{id} |
|
22
27
|
[**get_school_admin**](DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
|
23
28
|
[**get_school_admins**](DataApi.md#get_school_admins) | **GET** /school_admins |
|
@@ -26,14 +31,18 @@ Method | HTTP request | Description
|
|
26
31
|
[**get_school_for_teacher**](DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
|
27
32
|
[**get_schools**](DataApi.md#get_schools) | **GET** /schools |
|
28
33
|
[**get_schools_for_school_admin**](DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
|
34
|
+
[**get_schools_for_student**](DataApi.md#get_schools_for_student) | **GET** /students/{id}/schools |
|
35
|
+
[**get_schools_for_teacher**](DataApi.md#get_schools_for_teacher) | **GET** /teachers/{id}/schools |
|
29
36
|
[**get_section**](DataApi.md#get_section) | **GET** /sections/{id} |
|
30
37
|
[**get_sections**](DataApi.md#get_sections) | **GET** /sections |
|
38
|
+
[**get_sections_for_course**](DataApi.md#get_sections_for_course) | **GET** /courses/{id}/sections |
|
31
39
|
[**get_sections_for_school**](DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
|
32
40
|
[**get_sections_for_student**](DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
|
33
41
|
[**get_sections_for_teacher**](DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
|
42
|
+
[**get_sections_for_term**](DataApi.md#get_sections_for_term) | **GET** /terms/{id}/sections |
|
34
43
|
[**get_student**](DataApi.md#get_student) | **GET** /students/{id} |
|
35
|
-
[**get_student_for_contact**](DataApi.md#get_student_for_contact) | **GET** /contacts/{id}/student |
|
36
44
|
[**get_students**](DataApi.md#get_students) | **GET** /students |
|
45
|
+
[**get_students_for_contact**](DataApi.md#get_students_for_contact) | **GET** /contacts/{id}/students |
|
37
46
|
[**get_students_for_school**](DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
|
38
47
|
[**get_students_for_section**](DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
|
39
48
|
[**get_students_for_teacher**](DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
|
@@ -43,10 +52,13 @@ Method | HTTP request | Description
|
|
43
52
|
[**get_teachers_for_school**](DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
|
44
53
|
[**get_teachers_for_section**](DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
|
45
54
|
[**get_teachers_for_student**](DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
|
55
|
+
[**get_term**](DataApi.md#get_term) | **GET** /terms/{id} |
|
56
|
+
[**get_term_for_section**](DataApi.md#get_term_for_section) | **GET** /sections/{id}/term |
|
57
|
+
[**get_terms**](DataApi.md#get_terms) | **GET** /terms |
|
46
58
|
|
47
59
|
|
48
60
|
# **get_contact**
|
49
|
-
>
|
61
|
+
> ContactResponse get_contact(id)
|
50
62
|
|
51
63
|
|
52
64
|
|
@@ -83,7 +95,7 @@ Name | Type | Description | Notes
|
|
83
95
|
|
84
96
|
### Return type
|
85
97
|
|
86
|
-
[**
|
98
|
+
[**ContactResponse**](ContactResponse.md)
|
87
99
|
|
88
100
|
### Authorization
|
89
101
|
|
@@ -97,7 +109,7 @@ Name | Type | Description | Notes
|
|
97
109
|
|
98
110
|
|
99
111
|
# **get_contacts**
|
100
|
-
>
|
112
|
+
> ContactsResponse get_contacts(opts)
|
101
113
|
|
102
114
|
|
103
115
|
|
@@ -139,7 +151,7 @@ Name | Type | Description | Notes
|
|
139
151
|
|
140
152
|
### Return type
|
141
153
|
|
142
|
-
[**
|
154
|
+
[**ContactsResponse**](ContactsResponse.md)
|
143
155
|
|
144
156
|
### Authorization
|
145
157
|
|
@@ -153,7 +165,7 @@ Name | Type | Description | Notes
|
|
153
165
|
|
154
166
|
|
155
167
|
# **get_contacts_for_student**
|
156
|
-
>
|
168
|
+
> ContactsResponse get_contacts_for_student(id, opts)
|
157
169
|
|
158
170
|
|
159
171
|
|
@@ -174,14 +186,437 @@ api_instance = Clever::DataApi.new
|
|
174
186
|
id = "id_example" # String |
|
175
187
|
|
176
188
|
opts = {
|
177
|
-
limit: 56 # Integer |
|
189
|
+
limit: 56, # Integer |
|
190
|
+
starting_after: "starting_after_example", # String |
|
191
|
+
ending_before: "ending_before_example" # String |
|
192
|
+
}
|
193
|
+
|
194
|
+
begin
|
195
|
+
result = api_instance.get_contacts_for_student(id, opts)
|
196
|
+
p result
|
197
|
+
rescue Clever::ApiError => e
|
198
|
+
puts "Exception when calling DataApi->get_contacts_for_student: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Parameters
|
203
|
+
|
204
|
+
Name | Type | Description | Notes
|
205
|
+
------------- | ------------- | ------------- | -------------
|
206
|
+
**id** | **String**| |
|
207
|
+
**limit** | **Integer**| | [optional]
|
208
|
+
**starting_after** | **String**| | [optional]
|
209
|
+
**ending_before** | **String**| | [optional]
|
210
|
+
|
211
|
+
### Return type
|
212
|
+
|
213
|
+
[**ContactsResponse**](ContactsResponse.md)
|
214
|
+
|
215
|
+
### Authorization
|
216
|
+
|
217
|
+
[oauth](../README.md#oauth)
|
218
|
+
|
219
|
+
### HTTP request headers
|
220
|
+
|
221
|
+
- **Content-Type**: Not defined
|
222
|
+
- **Accept**: application/json
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
# **get_course**
|
227
|
+
> CourseResponse get_course(id)
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
Returns a specific course
|
232
|
+
|
233
|
+
### Example
|
234
|
+
```ruby
|
235
|
+
# load the gem
|
236
|
+
require 'clever-ruby'
|
237
|
+
# setup authorization
|
238
|
+
Clever.configure do |config|
|
239
|
+
# Configure OAuth2 access token for authorization: oauth
|
240
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
241
|
+
end
|
242
|
+
|
243
|
+
api_instance = Clever::DataApi.new
|
244
|
+
|
245
|
+
id = "id_example" # String |
|
246
|
+
|
247
|
+
|
248
|
+
begin
|
249
|
+
result = api_instance.get_course(id)
|
250
|
+
p result
|
251
|
+
rescue Clever::ApiError => e
|
252
|
+
puts "Exception when calling DataApi->get_course: #{e}"
|
253
|
+
end
|
254
|
+
```
|
255
|
+
|
256
|
+
### Parameters
|
257
|
+
|
258
|
+
Name | Type | Description | Notes
|
259
|
+
------------- | ------------- | ------------- | -------------
|
260
|
+
**id** | **String**| |
|
261
|
+
|
262
|
+
### Return type
|
263
|
+
|
264
|
+
[**CourseResponse**](CourseResponse.md)
|
265
|
+
|
266
|
+
### Authorization
|
267
|
+
|
268
|
+
[oauth](../README.md#oauth)
|
269
|
+
|
270
|
+
### HTTP request headers
|
271
|
+
|
272
|
+
- **Content-Type**: Not defined
|
273
|
+
- **Accept**: application/json
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
# **get_course_for_section**
|
278
|
+
> CourseResponse get_course_for_section(id)
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
Returns the course for a section
|
283
|
+
|
284
|
+
### Example
|
285
|
+
```ruby
|
286
|
+
# load the gem
|
287
|
+
require 'clever-ruby'
|
288
|
+
# setup authorization
|
289
|
+
Clever.configure do |config|
|
290
|
+
# Configure OAuth2 access token for authorization: oauth
|
291
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
292
|
+
end
|
293
|
+
|
294
|
+
api_instance = Clever::DataApi.new
|
295
|
+
|
296
|
+
id = "id_example" # String |
|
297
|
+
|
298
|
+
|
299
|
+
begin
|
300
|
+
result = api_instance.get_course_for_section(id)
|
301
|
+
p result
|
302
|
+
rescue Clever::ApiError => e
|
303
|
+
puts "Exception when calling DataApi->get_course_for_section: #{e}"
|
304
|
+
end
|
305
|
+
```
|
306
|
+
|
307
|
+
### Parameters
|
308
|
+
|
309
|
+
Name | Type | Description | Notes
|
310
|
+
------------- | ------------- | ------------- | -------------
|
311
|
+
**id** | **String**| |
|
312
|
+
|
313
|
+
### Return type
|
314
|
+
|
315
|
+
[**CourseResponse**](CourseResponse.md)
|
316
|
+
|
317
|
+
### Authorization
|
318
|
+
|
319
|
+
[oauth](../README.md#oauth)
|
320
|
+
|
321
|
+
### HTTP request headers
|
322
|
+
|
323
|
+
- **Content-Type**: Not defined
|
324
|
+
- **Accept**: application/json
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
# **get_courses**
|
329
|
+
> CoursesResponse get_courses(opts)
|
330
|
+
|
331
|
+
|
332
|
+
|
333
|
+
Returns a list of courses
|
334
|
+
|
335
|
+
### Example
|
336
|
+
```ruby
|
337
|
+
# load the gem
|
338
|
+
require 'clever-ruby'
|
339
|
+
# setup authorization
|
340
|
+
Clever.configure do |config|
|
341
|
+
# Configure OAuth2 access token for authorization: oauth
|
342
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
343
|
+
end
|
344
|
+
|
345
|
+
api_instance = Clever::DataApi.new
|
346
|
+
|
347
|
+
opts = {
|
348
|
+
limit: 56, # Integer |
|
349
|
+
starting_after: "starting_after_example", # String |
|
350
|
+
ending_before: "ending_before_example" # String |
|
178
351
|
}
|
179
352
|
|
180
353
|
begin
|
181
|
-
result = api_instance.
|
354
|
+
result = api_instance.get_courses(opts)
|
355
|
+
p result
|
356
|
+
rescue Clever::ApiError => e
|
357
|
+
puts "Exception when calling DataApi->get_courses: #{e}"
|
358
|
+
end
|
359
|
+
```
|
360
|
+
|
361
|
+
### Parameters
|
362
|
+
|
363
|
+
Name | Type | Description | Notes
|
364
|
+
------------- | ------------- | ------------- | -------------
|
365
|
+
**limit** | **Integer**| | [optional]
|
366
|
+
**starting_after** | **String**| | [optional]
|
367
|
+
**ending_before** | **String**| | [optional]
|
368
|
+
|
369
|
+
### Return type
|
370
|
+
|
371
|
+
[**CoursesResponse**](CoursesResponse.md)
|
372
|
+
|
373
|
+
### Authorization
|
374
|
+
|
375
|
+
[oauth](../README.md#oauth)
|
376
|
+
|
377
|
+
### HTTP request headers
|
378
|
+
|
379
|
+
- **Content-Type**: Not defined
|
380
|
+
- **Accept**: application/json
|
381
|
+
|
382
|
+
|
383
|
+
|
384
|
+
# **get_district**
|
385
|
+
> DistrictResponse get_district(id)
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
Returns a specific district
|
390
|
+
|
391
|
+
### Example
|
392
|
+
```ruby
|
393
|
+
# load the gem
|
394
|
+
require 'clever-ruby'
|
395
|
+
# setup authorization
|
396
|
+
Clever.configure do |config|
|
397
|
+
# Configure OAuth2 access token for authorization: oauth
|
398
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
399
|
+
end
|
400
|
+
|
401
|
+
api_instance = Clever::DataApi.new
|
402
|
+
|
403
|
+
id = "id_example" # String |
|
404
|
+
|
405
|
+
|
406
|
+
begin
|
407
|
+
result = api_instance.get_district(id)
|
408
|
+
p result
|
409
|
+
rescue Clever::ApiError => e
|
410
|
+
puts "Exception when calling DataApi->get_district: #{e}"
|
411
|
+
end
|
412
|
+
```
|
413
|
+
|
414
|
+
### Parameters
|
415
|
+
|
416
|
+
Name | Type | Description | Notes
|
417
|
+
------------- | ------------- | ------------- | -------------
|
418
|
+
**id** | **String**| |
|
419
|
+
|
420
|
+
### Return type
|
421
|
+
|
422
|
+
[**DistrictResponse**](DistrictResponse.md)
|
423
|
+
|
424
|
+
### Authorization
|
425
|
+
|
426
|
+
[oauth](../README.md#oauth)
|
427
|
+
|
428
|
+
### HTTP request headers
|
429
|
+
|
430
|
+
- **Content-Type**: Not defined
|
431
|
+
- **Accept**: application/json
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
# **get_district_admin**
|
436
|
+
> DistrictAdminResponse get_district_admin(id)
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
Returns a specific district admin
|
441
|
+
|
442
|
+
### Example
|
443
|
+
```ruby
|
444
|
+
# load the gem
|
445
|
+
require 'clever-ruby'
|
446
|
+
# setup authorization
|
447
|
+
Clever.configure do |config|
|
448
|
+
# Configure OAuth2 access token for authorization: oauth
|
449
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
450
|
+
end
|
451
|
+
|
452
|
+
api_instance = Clever::DataApi.new
|
453
|
+
|
454
|
+
id = "id_example" # String |
|
455
|
+
|
456
|
+
|
457
|
+
begin
|
458
|
+
result = api_instance.get_district_admin(id)
|
459
|
+
p result
|
460
|
+
rescue Clever::ApiError => e
|
461
|
+
puts "Exception when calling DataApi->get_district_admin: #{e}"
|
462
|
+
end
|
463
|
+
```
|
464
|
+
|
465
|
+
### Parameters
|
466
|
+
|
467
|
+
Name | Type | Description | Notes
|
468
|
+
------------- | ------------- | ------------- | -------------
|
469
|
+
**id** | **String**| |
|
470
|
+
|
471
|
+
### Return type
|
472
|
+
|
473
|
+
[**DistrictAdminResponse**](DistrictAdminResponse.md)
|
474
|
+
|
475
|
+
### Authorization
|
476
|
+
|
477
|
+
[oauth](../README.md#oauth)
|
478
|
+
|
479
|
+
### HTTP request headers
|
480
|
+
|
481
|
+
- **Content-Type**: Not defined
|
482
|
+
- **Accept**: application/json
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
# **get_district_admins**
|
487
|
+
> DistrictAdminsResponse get_district_admins(opts)
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
Returns a list of district admins
|
492
|
+
|
493
|
+
### Example
|
494
|
+
```ruby
|
495
|
+
# load the gem
|
496
|
+
require 'clever-ruby'
|
497
|
+
# setup authorization
|
498
|
+
Clever.configure do |config|
|
499
|
+
# Configure OAuth2 access token for authorization: oauth
|
500
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
501
|
+
end
|
502
|
+
|
503
|
+
api_instance = Clever::DataApi.new
|
504
|
+
|
505
|
+
opts = {
|
506
|
+
limit: 56, # Integer |
|
507
|
+
starting_after: "starting_after_example", # String |
|
508
|
+
ending_before: "ending_before_example" # String |
|
509
|
+
}
|
510
|
+
|
511
|
+
begin
|
512
|
+
result = api_instance.get_district_admins(opts)
|
513
|
+
p result
|
514
|
+
rescue Clever::ApiError => e
|
515
|
+
puts "Exception when calling DataApi->get_district_admins: #{e}"
|
516
|
+
end
|
517
|
+
```
|
518
|
+
|
519
|
+
### Parameters
|
520
|
+
|
521
|
+
Name | Type | Description | Notes
|
522
|
+
------------- | ------------- | ------------- | -------------
|
523
|
+
**limit** | **Integer**| | [optional]
|
524
|
+
**starting_after** | **String**| | [optional]
|
525
|
+
**ending_before** | **String**| | [optional]
|
526
|
+
|
527
|
+
### Return type
|
528
|
+
|
529
|
+
[**DistrictAdminsResponse**](DistrictAdminsResponse.md)
|
530
|
+
|
531
|
+
### Authorization
|
532
|
+
|
533
|
+
[oauth](../README.md#oauth)
|
534
|
+
|
535
|
+
### HTTP request headers
|
536
|
+
|
537
|
+
- **Content-Type**: Not defined
|
538
|
+
- **Accept**: application/json
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
# **get_district_for_contact**
|
543
|
+
> DistrictResponse get_district_for_contact(id)
|
544
|
+
|
545
|
+
|
546
|
+
|
547
|
+
Returns the district for a student contact
|
548
|
+
|
549
|
+
### Example
|
550
|
+
```ruby
|
551
|
+
# load the gem
|
552
|
+
require 'clever-ruby'
|
553
|
+
# setup authorization
|
554
|
+
Clever.configure do |config|
|
555
|
+
# Configure OAuth2 access token for authorization: oauth
|
556
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
557
|
+
end
|
558
|
+
|
559
|
+
api_instance = Clever::DataApi.new
|
560
|
+
|
561
|
+
id = "id_example" # String |
|
562
|
+
|
563
|
+
|
564
|
+
begin
|
565
|
+
result = api_instance.get_district_for_contact(id)
|
566
|
+
p result
|
567
|
+
rescue Clever::ApiError => e
|
568
|
+
puts "Exception when calling DataApi->get_district_for_contact: #{e}"
|
569
|
+
end
|
570
|
+
```
|
571
|
+
|
572
|
+
### Parameters
|
573
|
+
|
574
|
+
Name | Type | Description | Notes
|
575
|
+
------------- | ------------- | ------------- | -------------
|
576
|
+
**id** | **String**| |
|
577
|
+
|
578
|
+
### Return type
|
579
|
+
|
580
|
+
[**DistrictResponse**](DistrictResponse.md)
|
581
|
+
|
582
|
+
### Authorization
|
583
|
+
|
584
|
+
[oauth](../README.md#oauth)
|
585
|
+
|
586
|
+
### HTTP request headers
|
587
|
+
|
588
|
+
- **Content-Type**: Not defined
|
589
|
+
- **Accept**: application/json
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
# **get_district_for_course**
|
594
|
+
> DistrictResponse get_district_for_course(id)
|
595
|
+
|
596
|
+
|
597
|
+
|
598
|
+
Returns the district for a course
|
599
|
+
|
600
|
+
### Example
|
601
|
+
```ruby
|
602
|
+
# load the gem
|
603
|
+
require 'clever-ruby'
|
604
|
+
# setup authorization
|
605
|
+
Clever.configure do |config|
|
606
|
+
# Configure OAuth2 access token for authorization: oauth
|
607
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
608
|
+
end
|
609
|
+
|
610
|
+
api_instance = Clever::DataApi.new
|
611
|
+
|
612
|
+
id = "id_example" # String |
|
613
|
+
|
614
|
+
|
615
|
+
begin
|
616
|
+
result = api_instance.get_district_for_course(id)
|
182
617
|
p result
|
183
618
|
rescue Clever::ApiError => e
|
184
|
-
puts "Exception when calling DataApi->
|
619
|
+
puts "Exception when calling DataApi->get_district_for_course: #{e}"
|
185
620
|
end
|
186
621
|
```
|
187
622
|
|
@@ -190,11 +625,10 @@ end
|
|
190
625
|
Name | Type | Description | Notes
|
191
626
|
------------- | ------------- | ------------- | -------------
|
192
627
|
**id** | **String**| |
|
193
|
-
**limit** | **Integer**| | [optional]
|
194
628
|
|
195
629
|
### Return type
|
196
630
|
|
197
|
-
[**
|
631
|
+
[**DistrictResponse**](DistrictResponse.md)
|
198
632
|
|
199
633
|
### Authorization
|
200
634
|
|
@@ -207,12 +641,12 @@ Name | Type | Description | Notes
|
|
207
641
|
|
208
642
|
|
209
643
|
|
210
|
-
# **
|
211
|
-
> DistrictResponse
|
644
|
+
# **get_district_for_district_admin**
|
645
|
+
> DistrictResponse get_district_for_district_admin(id)
|
212
646
|
|
213
647
|
|
214
648
|
|
215
|
-
Returns a
|
649
|
+
Returns the district for a district admin
|
216
650
|
|
217
651
|
### Example
|
218
652
|
```ruby
|
@@ -230,10 +664,10 @@ id = "id_example" # String |
|
|
230
664
|
|
231
665
|
|
232
666
|
begin
|
233
|
-
result = api_instance.
|
667
|
+
result = api_instance.get_district_for_district_admin(id)
|
234
668
|
p result
|
235
669
|
rescue Clever::ApiError => e
|
236
|
-
puts "Exception when calling DataApi->
|
670
|
+
puts "Exception when calling DataApi->get_district_for_district_admin: #{e}"
|
237
671
|
end
|
238
672
|
```
|
239
673
|
|
@@ -258,12 +692,12 @@ Name | Type | Description | Notes
|
|
258
692
|
|
259
693
|
|
260
694
|
|
261
|
-
# **
|
262
|
-
>
|
695
|
+
# **get_district_for_school**
|
696
|
+
> DistrictResponse get_district_for_school(id)
|
263
697
|
|
264
698
|
|
265
699
|
|
266
|
-
Returns
|
700
|
+
Returns the district for a school
|
267
701
|
|
268
702
|
### Example
|
269
703
|
```ruby
|
@@ -281,10 +715,10 @@ id = "id_example" # String |
|
|
281
715
|
|
282
716
|
|
283
717
|
begin
|
284
|
-
result = api_instance.
|
718
|
+
result = api_instance.get_district_for_school(id)
|
285
719
|
p result
|
286
720
|
rescue Clever::ApiError => e
|
287
|
-
puts "Exception when calling DataApi->
|
721
|
+
puts "Exception when calling DataApi->get_district_for_school: #{e}"
|
288
722
|
end
|
289
723
|
```
|
290
724
|
|
@@ -296,7 +730,7 @@ Name | Type | Description | Notes
|
|
296
730
|
|
297
731
|
### Return type
|
298
732
|
|
299
|
-
[**
|
733
|
+
[**DistrictResponse**](DistrictResponse.md)
|
300
734
|
|
301
735
|
### Authorization
|
302
736
|
|
@@ -309,12 +743,12 @@ Name | Type | Description | Notes
|
|
309
743
|
|
310
744
|
|
311
745
|
|
312
|
-
# **
|
313
|
-
>
|
746
|
+
# **get_district_for_school_admin**
|
747
|
+
> DistrictResponse get_district_for_school_admin(id)
|
314
748
|
|
315
749
|
|
316
750
|
|
317
|
-
Returns
|
751
|
+
Returns the district for a school admin
|
318
752
|
|
319
753
|
### Example
|
320
754
|
```ruby
|
@@ -328,16 +762,14 @@ end
|
|
328
762
|
|
329
763
|
api_instance = Clever::DataApi.new
|
330
764
|
|
331
|
-
|
332
|
-
|
333
|
-
ending_before: "ending_before_example" # String |
|
334
|
-
}
|
765
|
+
id = "id_example" # String |
|
766
|
+
|
335
767
|
|
336
768
|
begin
|
337
|
-
result = api_instance.
|
769
|
+
result = api_instance.get_district_for_school_admin(id)
|
338
770
|
p result
|
339
771
|
rescue Clever::ApiError => e
|
340
|
-
puts "Exception when calling DataApi->
|
772
|
+
puts "Exception when calling DataApi->get_district_for_school_admin: #{e}"
|
341
773
|
end
|
342
774
|
```
|
343
775
|
|
@@ -345,12 +777,11 @@ end
|
|
345
777
|
|
346
778
|
Name | Type | Description | Notes
|
347
779
|
------------- | ------------- | ------------- | -------------
|
348
|
-
**
|
349
|
-
**ending_before** | **String**| | [optional]
|
780
|
+
**id** | **String**| |
|
350
781
|
|
351
782
|
### Return type
|
352
783
|
|
353
|
-
[**
|
784
|
+
[**DistrictResponse**](DistrictResponse.md)
|
354
785
|
|
355
786
|
### Authorization
|
356
787
|
|
@@ -363,12 +794,12 @@ Name | Type | Description | Notes
|
|
363
794
|
|
364
795
|
|
365
796
|
|
366
|
-
# **
|
367
|
-
> DistrictResponse
|
797
|
+
# **get_district_for_section**
|
798
|
+
> DistrictResponse get_district_for_section(id)
|
368
799
|
|
369
800
|
|
370
801
|
|
371
|
-
Returns the district for a
|
802
|
+
Returns the district for a section
|
372
803
|
|
373
804
|
### Example
|
374
805
|
```ruby
|
@@ -386,10 +817,10 @@ id = "id_example" # String |
|
|
386
817
|
|
387
818
|
|
388
819
|
begin
|
389
|
-
result = api_instance.
|
820
|
+
result = api_instance.get_district_for_section(id)
|
390
821
|
p result
|
391
822
|
rescue Clever::ApiError => e
|
392
|
-
puts "Exception when calling DataApi->
|
823
|
+
puts "Exception when calling DataApi->get_district_for_section: #{e}"
|
393
824
|
end
|
394
825
|
```
|
395
826
|
|
@@ -414,12 +845,12 @@ Name | Type | Description | Notes
|
|
414
845
|
|
415
846
|
|
416
847
|
|
417
|
-
# **
|
418
|
-
> DistrictResponse
|
848
|
+
# **get_district_for_student**
|
849
|
+
> DistrictResponse get_district_for_student(id)
|
419
850
|
|
420
851
|
|
421
852
|
|
422
|
-
Returns the district for a
|
853
|
+
Returns the district for a student
|
423
854
|
|
424
855
|
### Example
|
425
856
|
```ruby
|
@@ -437,10 +868,10 @@ id = "id_example" # String |
|
|
437
868
|
|
438
869
|
|
439
870
|
begin
|
440
|
-
result = api_instance.
|
871
|
+
result = api_instance.get_district_for_student(id)
|
441
872
|
p result
|
442
873
|
rescue Clever::ApiError => e
|
443
|
-
puts "Exception when calling DataApi->
|
874
|
+
puts "Exception when calling DataApi->get_district_for_student: #{e}"
|
444
875
|
end
|
445
876
|
```
|
446
877
|
|
@@ -465,12 +896,12 @@ Name | Type | Description | Notes
|
|
465
896
|
|
466
897
|
|
467
898
|
|
468
|
-
# **
|
469
|
-
> DistrictResponse
|
899
|
+
# **get_district_for_teacher**
|
900
|
+
> DistrictResponse get_district_for_teacher(id)
|
470
901
|
|
471
902
|
|
472
903
|
|
473
|
-
Returns the district for a
|
904
|
+
Returns the district for a teacher
|
474
905
|
|
475
906
|
### Example
|
476
907
|
```ruby
|
@@ -488,10 +919,10 @@ id = "id_example" # String |
|
|
488
919
|
|
489
920
|
|
490
921
|
begin
|
491
|
-
result = api_instance.
|
922
|
+
result = api_instance.get_district_for_teacher(id)
|
492
923
|
p result
|
493
924
|
rescue Clever::ApiError => e
|
494
|
-
puts "Exception when calling DataApi->
|
925
|
+
puts "Exception when calling DataApi->get_district_for_teacher: #{e}"
|
495
926
|
end
|
496
927
|
```
|
497
928
|
|
@@ -516,12 +947,12 @@ Name | Type | Description | Notes
|
|
516
947
|
|
517
948
|
|
518
949
|
|
519
|
-
# **
|
520
|
-
> DistrictResponse
|
950
|
+
# **get_district_for_term**
|
951
|
+
> DistrictResponse get_district_for_term(id)
|
521
952
|
|
522
953
|
|
523
954
|
|
524
|
-
Returns the district for a
|
955
|
+
Returns the district for a term
|
525
956
|
|
526
957
|
### Example
|
527
958
|
```ruby
|
@@ -539,10 +970,10 @@ id = "id_example" # String |
|
|
539
970
|
|
540
971
|
|
541
972
|
begin
|
542
|
-
result = api_instance.
|
973
|
+
result = api_instance.get_district_for_term(id)
|
543
974
|
p result
|
544
975
|
rescue Clever::ApiError => e
|
545
|
-
puts "Exception when calling DataApi->
|
976
|
+
puts "Exception when calling DataApi->get_district_for_term: #{e}"
|
546
977
|
end
|
547
978
|
```
|
548
979
|
|
@@ -567,12 +998,57 @@ Name | Type | Description | Notes
|
|
567
998
|
|
568
999
|
|
569
1000
|
|
570
|
-
# **
|
571
|
-
>
|
1001
|
+
# **get_districts**
|
1002
|
+
> DistrictsResponse get_districts
|
572
1003
|
|
573
1004
|
|
574
1005
|
|
575
|
-
Returns
|
1006
|
+
Returns a list of districts
|
1007
|
+
|
1008
|
+
### Example
|
1009
|
+
```ruby
|
1010
|
+
# load the gem
|
1011
|
+
require 'clever-ruby'
|
1012
|
+
# setup authorization
|
1013
|
+
Clever.configure do |config|
|
1014
|
+
# Configure OAuth2 access token for authorization: oauth
|
1015
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1016
|
+
end
|
1017
|
+
|
1018
|
+
api_instance = Clever::DataApi.new
|
1019
|
+
|
1020
|
+
begin
|
1021
|
+
result = api_instance.get_districts
|
1022
|
+
p result
|
1023
|
+
rescue Clever::ApiError => e
|
1024
|
+
puts "Exception when calling DataApi->get_districts: #{e}"
|
1025
|
+
end
|
1026
|
+
```
|
1027
|
+
|
1028
|
+
### Parameters
|
1029
|
+
This endpoint does not need any parameter.
|
1030
|
+
|
1031
|
+
### Return type
|
1032
|
+
|
1033
|
+
[**DistrictsResponse**](DistrictsResponse.md)
|
1034
|
+
|
1035
|
+
### Authorization
|
1036
|
+
|
1037
|
+
[oauth](../README.md#oauth)
|
1038
|
+
|
1039
|
+
### HTTP request headers
|
1040
|
+
|
1041
|
+
- **Content-Type**: Not defined
|
1042
|
+
- **Accept**: application/json
|
1043
|
+
|
1044
|
+
|
1045
|
+
|
1046
|
+
# **get_school**
|
1047
|
+
> SchoolResponse get_school(id)
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
Returns a specific school
|
576
1052
|
|
577
1053
|
### Example
|
578
1054
|
```ruby
|
@@ -590,10 +1066,10 @@ id = "id_example" # String |
|
|
590
1066
|
|
591
1067
|
|
592
1068
|
begin
|
593
|
-
result = api_instance.
|
1069
|
+
result = api_instance.get_school(id)
|
594
1070
|
p result
|
595
1071
|
rescue Clever::ApiError => e
|
596
|
-
puts "Exception when calling DataApi->
|
1072
|
+
puts "Exception when calling DataApi->get_school: #{e}"
|
597
1073
|
end
|
598
1074
|
```
|
599
1075
|
|
@@ -605,7 +1081,7 @@ Name | Type | Description | Notes
|
|
605
1081
|
|
606
1082
|
### Return type
|
607
1083
|
|
608
|
-
[**
|
1084
|
+
[**SchoolResponse**](SchoolResponse.md)
|
609
1085
|
|
610
1086
|
### Authorization
|
611
1087
|
|
@@ -618,12 +1094,12 @@ Name | Type | Description | Notes
|
|
618
1094
|
|
619
1095
|
|
620
1096
|
|
621
|
-
# **
|
622
|
-
>
|
1097
|
+
# **get_school_admin**
|
1098
|
+
> SchoolAdminResponse get_school_admin(id)
|
623
1099
|
|
624
1100
|
|
625
1101
|
|
626
|
-
Returns
|
1102
|
+
Returns a specific school admin
|
627
1103
|
|
628
1104
|
### Example
|
629
1105
|
```ruby
|
@@ -641,10 +1117,10 @@ id = "id_example" # String |
|
|
641
1117
|
|
642
1118
|
|
643
1119
|
begin
|
644
|
-
result = api_instance.
|
1120
|
+
result = api_instance.get_school_admin(id)
|
645
1121
|
p result
|
646
1122
|
rescue Clever::ApiError => e
|
647
|
-
puts "Exception when calling DataApi->
|
1123
|
+
puts "Exception when calling DataApi->get_school_admin: #{e}"
|
648
1124
|
end
|
649
1125
|
```
|
650
1126
|
|
@@ -656,7 +1132,7 @@ Name | Type | Description | Notes
|
|
656
1132
|
|
657
1133
|
### Return type
|
658
1134
|
|
659
|
-
[**
|
1135
|
+
[**SchoolAdminResponse**](SchoolAdminResponse.md)
|
660
1136
|
|
661
1137
|
### Authorization
|
662
1138
|
|
@@ -669,12 +1145,12 @@ Name | Type | Description | Notes
|
|
669
1145
|
|
670
1146
|
|
671
1147
|
|
672
|
-
# **
|
673
|
-
>
|
1148
|
+
# **get_school_admins**
|
1149
|
+
> SchoolAdminsResponse get_school_admins(opts)
|
674
1150
|
|
675
1151
|
|
676
1152
|
|
677
|
-
Returns a list of
|
1153
|
+
Returns a list of school admins
|
678
1154
|
|
679
1155
|
### Example
|
680
1156
|
```ruby
|
@@ -688,20 +1164,31 @@ end
|
|
688
1164
|
|
689
1165
|
api_instance = Clever::DataApi.new
|
690
1166
|
|
1167
|
+
opts = {
|
1168
|
+
limit: 56, # Integer |
|
1169
|
+
starting_after: "starting_after_example", # String |
|
1170
|
+
ending_before: "ending_before_example" # String |
|
1171
|
+
}
|
1172
|
+
|
691
1173
|
begin
|
692
|
-
result = api_instance.
|
1174
|
+
result = api_instance.get_school_admins(opts)
|
693
1175
|
p result
|
694
1176
|
rescue Clever::ApiError => e
|
695
|
-
puts "Exception when calling DataApi->
|
1177
|
+
puts "Exception when calling DataApi->get_school_admins: #{e}"
|
696
1178
|
end
|
697
1179
|
```
|
698
1180
|
|
699
1181
|
### Parameters
|
700
|
-
|
1182
|
+
|
1183
|
+
Name | Type | Description | Notes
|
1184
|
+
------------- | ------------- | ------------- | -------------
|
1185
|
+
**limit** | **Integer**| | [optional]
|
1186
|
+
**starting_after** | **String**| | [optional]
|
1187
|
+
**ending_before** | **String**| | [optional]
|
701
1188
|
|
702
1189
|
### Return type
|
703
1190
|
|
704
|
-
[**
|
1191
|
+
[**SchoolAdminsResponse**](SchoolAdminsResponse.md)
|
705
1192
|
|
706
1193
|
### Authorization
|
707
1194
|
|
@@ -714,12 +1201,12 @@ This endpoint does not need any parameter.
|
|
714
1201
|
|
715
1202
|
|
716
1203
|
|
717
|
-
# **
|
718
|
-
>
|
1204
|
+
# **get_school_for_section**
|
1205
|
+
> SchoolResponse get_school_for_section(id)
|
719
1206
|
|
720
1207
|
|
721
1208
|
|
722
|
-
Returns the
|
1209
|
+
Returns the school for a section
|
723
1210
|
|
724
1211
|
### Example
|
725
1212
|
```ruby
|
@@ -737,10 +1224,10 @@ id = "id_example" # String |
|
|
737
1224
|
|
738
1225
|
|
739
1226
|
begin
|
740
|
-
result = api_instance.
|
1227
|
+
result = api_instance.get_school_for_section(id)
|
741
1228
|
p result
|
742
1229
|
rescue Clever::ApiError => e
|
743
|
-
puts "Exception when calling DataApi->
|
1230
|
+
puts "Exception when calling DataApi->get_school_for_section: #{e}"
|
744
1231
|
end
|
745
1232
|
```
|
746
1233
|
|
@@ -752,7 +1239,7 @@ Name | Type | Description | Notes
|
|
752
1239
|
|
753
1240
|
### Return type
|
754
1241
|
|
755
|
-
[**
|
1242
|
+
[**SchoolResponse**](SchoolResponse.md)
|
756
1243
|
|
757
1244
|
### Authorization
|
758
1245
|
|
@@ -765,12 +1252,12 @@ Name | Type | Description | Notes
|
|
765
1252
|
|
766
1253
|
|
767
1254
|
|
768
|
-
# **
|
769
|
-
> SchoolResponse
|
1255
|
+
# **get_school_for_student**
|
1256
|
+
> SchoolResponse get_school_for_student(id)
|
770
1257
|
|
771
1258
|
|
772
1259
|
|
773
|
-
Returns
|
1260
|
+
Returns the primary school for a student
|
774
1261
|
|
775
1262
|
### Example
|
776
1263
|
```ruby
|
@@ -788,10 +1275,10 @@ id = "id_example" # String |
|
|
788
1275
|
|
789
1276
|
|
790
1277
|
begin
|
791
|
-
result = api_instance.
|
1278
|
+
result = api_instance.get_school_for_student(id)
|
792
1279
|
p result
|
793
1280
|
rescue Clever::ApiError => e
|
794
|
-
puts "Exception when calling DataApi->
|
1281
|
+
puts "Exception when calling DataApi->get_school_for_student: #{e}"
|
795
1282
|
end
|
796
1283
|
```
|
797
1284
|
|
@@ -816,12 +1303,12 @@ Name | Type | Description | Notes
|
|
816
1303
|
|
817
1304
|
|
818
1305
|
|
819
|
-
# **
|
820
|
-
>
|
1306
|
+
# **get_school_for_teacher**
|
1307
|
+
> SchoolResponse get_school_for_teacher(id)
|
821
1308
|
|
822
1309
|
|
823
1310
|
|
824
|
-
|
1311
|
+
Retrieves school info for a teacher.
|
825
1312
|
|
826
1313
|
### Example
|
827
1314
|
```ruby
|
@@ -839,10 +1326,10 @@ id = "id_example" # String |
|
|
839
1326
|
|
840
1327
|
|
841
1328
|
begin
|
842
|
-
result = api_instance.
|
1329
|
+
result = api_instance.get_school_for_teacher(id)
|
843
1330
|
p result
|
844
1331
|
rescue Clever::ApiError => e
|
845
|
-
puts "Exception when calling DataApi->
|
1332
|
+
puts "Exception when calling DataApi->get_school_for_teacher: #{e}"
|
846
1333
|
end
|
847
1334
|
```
|
848
1335
|
|
@@ -854,7 +1341,7 @@ Name | Type | Description | Notes
|
|
854
1341
|
|
855
1342
|
### Return type
|
856
1343
|
|
857
|
-
[**
|
1344
|
+
[**SchoolResponse**](SchoolResponse.md)
|
858
1345
|
|
859
1346
|
### Authorization
|
860
1347
|
|
@@ -867,12 +1354,12 @@ Name | Type | Description | Notes
|
|
867
1354
|
|
868
1355
|
|
869
1356
|
|
870
|
-
# **
|
871
|
-
>
|
1357
|
+
# **get_schools**
|
1358
|
+
> SchoolsResponse get_schools(opts)
|
872
1359
|
|
873
1360
|
|
874
1361
|
|
875
|
-
Returns a list of
|
1362
|
+
Returns a list of schools
|
876
1363
|
|
877
1364
|
### Example
|
878
1365
|
```ruby
|
@@ -893,10 +1380,10 @@ opts = {
|
|
893
1380
|
}
|
894
1381
|
|
895
1382
|
begin
|
896
|
-
result = api_instance.
|
1383
|
+
result = api_instance.get_schools(opts)
|
897
1384
|
p result
|
898
1385
|
rescue Clever::ApiError => e
|
899
|
-
puts "Exception when calling DataApi->
|
1386
|
+
puts "Exception when calling DataApi->get_schools: #{e}"
|
900
1387
|
end
|
901
1388
|
```
|
902
1389
|
|
@@ -910,7 +1397,7 @@ Name | Type | Description | Notes
|
|
910
1397
|
|
911
1398
|
### Return type
|
912
1399
|
|
913
|
-
[**
|
1400
|
+
[**SchoolsResponse**](SchoolsResponse.md)
|
914
1401
|
|
915
1402
|
### Authorization
|
916
1403
|
|
@@ -923,12 +1410,12 @@ Name | Type | Description | Notes
|
|
923
1410
|
|
924
1411
|
|
925
1412
|
|
926
|
-
# **
|
927
|
-
>
|
1413
|
+
# **get_schools_for_school_admin**
|
1414
|
+
> SchoolsResponse get_schools_for_school_admin(id, opts)
|
928
1415
|
|
929
1416
|
|
930
1417
|
|
931
|
-
Returns the
|
1418
|
+
Returns the schools for a school admin
|
932
1419
|
|
933
1420
|
### Example
|
934
1421
|
```ruby
|
@@ -944,12 +1431,17 @@ api_instance = Clever::DataApi.new
|
|
944
1431
|
|
945
1432
|
id = "id_example" # String |
|
946
1433
|
|
1434
|
+
opts = {
|
1435
|
+
limit: 56, # Integer |
|
1436
|
+
starting_after: "starting_after_example", # String |
|
1437
|
+
ending_before: "ending_before_example" # String |
|
1438
|
+
}
|
947
1439
|
|
948
1440
|
begin
|
949
|
-
result = api_instance.
|
1441
|
+
result = api_instance.get_schools_for_school_admin(id, opts)
|
950
1442
|
p result
|
951
1443
|
rescue Clever::ApiError => e
|
952
|
-
puts "Exception when calling DataApi->
|
1444
|
+
puts "Exception when calling DataApi->get_schools_for_school_admin: #{e}"
|
953
1445
|
end
|
954
1446
|
```
|
955
1447
|
|
@@ -958,10 +1450,13 @@ end
|
|
958
1450
|
Name | Type | Description | Notes
|
959
1451
|
------------- | ------------- | ------------- | -------------
|
960
1452
|
**id** | **String**| |
|
1453
|
+
**limit** | **Integer**| | [optional]
|
1454
|
+
**starting_after** | **String**| | [optional]
|
1455
|
+
**ending_before** | **String**| | [optional]
|
961
1456
|
|
962
1457
|
### Return type
|
963
1458
|
|
964
|
-
[**
|
1459
|
+
[**SchoolsResponse**](SchoolsResponse.md)
|
965
1460
|
|
966
1461
|
### Authorization
|
967
1462
|
|
@@ -974,12 +1469,12 @@ Name | Type | Description | Notes
|
|
974
1469
|
|
975
1470
|
|
976
1471
|
|
977
|
-
# **
|
978
|
-
>
|
1472
|
+
# **get_schools_for_student**
|
1473
|
+
> SchoolsResponse get_schools_for_student(id, opts)
|
979
1474
|
|
980
1475
|
|
981
1476
|
|
982
|
-
Returns the
|
1477
|
+
Returns the schools for a student
|
983
1478
|
|
984
1479
|
### Example
|
985
1480
|
```ruby
|
@@ -995,12 +1490,17 @@ api_instance = Clever::DataApi.new
|
|
995
1490
|
|
996
1491
|
id = "id_example" # String |
|
997
1492
|
|
1493
|
+
opts = {
|
1494
|
+
limit: 56, # Integer |
|
1495
|
+
starting_after: "starting_after_example", # String |
|
1496
|
+
ending_before: "ending_before_example" # String |
|
1497
|
+
}
|
998
1498
|
|
999
1499
|
begin
|
1000
|
-
result = api_instance.
|
1500
|
+
result = api_instance.get_schools_for_student(id, opts)
|
1001
1501
|
p result
|
1002
1502
|
rescue Clever::ApiError => e
|
1003
|
-
puts "Exception when calling DataApi->
|
1503
|
+
puts "Exception when calling DataApi->get_schools_for_student: #{e}"
|
1004
1504
|
end
|
1005
1505
|
```
|
1006
1506
|
|
@@ -1009,10 +1509,13 @@ end
|
|
1009
1509
|
Name | Type | Description | Notes
|
1010
1510
|
------------- | ------------- | ------------- | -------------
|
1011
1511
|
**id** | **String**| |
|
1512
|
+
**limit** | **Integer**| | [optional]
|
1513
|
+
**starting_after** | **String**| | [optional]
|
1514
|
+
**ending_before** | **String**| | [optional]
|
1012
1515
|
|
1013
1516
|
### Return type
|
1014
1517
|
|
1015
|
-
[**
|
1518
|
+
[**SchoolsResponse**](SchoolsResponse.md)
|
1016
1519
|
|
1017
1520
|
### Authorization
|
1018
1521
|
|
@@ -1025,12 +1528,12 @@ Name | Type | Description | Notes
|
|
1025
1528
|
|
1026
1529
|
|
1027
1530
|
|
1028
|
-
# **
|
1029
|
-
>
|
1531
|
+
# **get_schools_for_teacher**
|
1532
|
+
> SchoolsResponse get_schools_for_teacher(id, opts)
|
1030
1533
|
|
1031
1534
|
|
1032
1535
|
|
1033
|
-
|
1536
|
+
Returns the schools for a teacher
|
1034
1537
|
|
1035
1538
|
### Example
|
1036
1539
|
```ruby
|
@@ -1046,12 +1549,17 @@ api_instance = Clever::DataApi.new
|
|
1046
1549
|
|
1047
1550
|
id = "id_example" # String |
|
1048
1551
|
|
1552
|
+
opts = {
|
1553
|
+
limit: 56, # Integer |
|
1554
|
+
starting_after: "starting_after_example", # String |
|
1555
|
+
ending_before: "ending_before_example" # String |
|
1556
|
+
}
|
1049
1557
|
|
1050
1558
|
begin
|
1051
|
-
result = api_instance.
|
1559
|
+
result = api_instance.get_schools_for_teacher(id, opts)
|
1052
1560
|
p result
|
1053
1561
|
rescue Clever::ApiError => e
|
1054
|
-
puts "Exception when calling DataApi->
|
1562
|
+
puts "Exception when calling DataApi->get_schools_for_teacher: #{e}"
|
1055
1563
|
end
|
1056
1564
|
```
|
1057
1565
|
|
@@ -1060,10 +1568,13 @@ end
|
|
1060
1568
|
Name | Type | Description | Notes
|
1061
1569
|
------------- | ------------- | ------------- | -------------
|
1062
1570
|
**id** | **String**| |
|
1571
|
+
**limit** | **Integer**| | [optional]
|
1572
|
+
**starting_after** | **String**| | [optional]
|
1573
|
+
**ending_before** | **String**| | [optional]
|
1063
1574
|
|
1064
1575
|
### Return type
|
1065
1576
|
|
1066
|
-
[**
|
1577
|
+
[**SchoolsResponse**](SchoolsResponse.md)
|
1067
1578
|
|
1068
1579
|
### Authorization
|
1069
1580
|
|
@@ -1076,12 +1587,12 @@ Name | Type | Description | Notes
|
|
1076
1587
|
|
1077
1588
|
|
1078
1589
|
|
1079
|
-
# **
|
1080
|
-
>
|
1081
|
-
|
1590
|
+
# **get_section**
|
1591
|
+
> SectionResponse get_section(id)
|
1082
1592
|
|
1083
1593
|
|
1084
|
-
|
1594
|
+
|
1595
|
+
Returns a specific section
|
1085
1596
|
|
1086
1597
|
### Example
|
1087
1598
|
```ruby
|
@@ -1095,17 +1606,14 @@ end
|
|
1095
1606
|
|
1096
1607
|
api_instance = Clever::DataApi.new
|
1097
1608
|
|
1098
|
-
|
1099
|
-
|
1100
|
-
starting_after: "starting_after_example", # String |
|
1101
|
-
ending_before: "ending_before_example" # String |
|
1102
|
-
}
|
1609
|
+
id = "id_example" # String |
|
1610
|
+
|
1103
1611
|
|
1104
1612
|
begin
|
1105
|
-
result = api_instance.
|
1613
|
+
result = api_instance.get_section(id)
|
1106
1614
|
p result
|
1107
1615
|
rescue Clever::ApiError => e
|
1108
|
-
puts "Exception when calling DataApi->
|
1616
|
+
puts "Exception when calling DataApi->get_section: #{e}"
|
1109
1617
|
end
|
1110
1618
|
```
|
1111
1619
|
|
@@ -1113,13 +1621,11 @@ end
|
|
1113
1621
|
|
1114
1622
|
Name | Type | Description | Notes
|
1115
1623
|
------------- | ------------- | ------------- | -------------
|
1116
|
-
**
|
1117
|
-
**starting_after** | **String**| | [optional]
|
1118
|
-
**ending_before** | **String**| | [optional]
|
1624
|
+
**id** | **String**| |
|
1119
1625
|
|
1120
1626
|
### Return type
|
1121
1627
|
|
1122
|
-
[**
|
1628
|
+
[**SectionResponse**](SectionResponse.md)
|
1123
1629
|
|
1124
1630
|
### Authorization
|
1125
1631
|
|
@@ -1132,12 +1638,12 @@ Name | Type | Description | Notes
|
|
1132
1638
|
|
1133
1639
|
|
1134
1640
|
|
1135
|
-
# **
|
1136
|
-
>
|
1641
|
+
# **get_sections**
|
1642
|
+
> SectionsResponse get_sections(opts)
|
1137
1643
|
|
1138
1644
|
|
1139
1645
|
|
1140
|
-
Returns
|
1646
|
+
Returns a list of sections
|
1141
1647
|
|
1142
1648
|
### Example
|
1143
1649
|
```ruby
|
@@ -1151,8 +1657,6 @@ end
|
|
1151
1657
|
|
1152
1658
|
api_instance = Clever::DataApi.new
|
1153
1659
|
|
1154
|
-
id = "id_example" # String |
|
1155
|
-
|
1156
1660
|
opts = {
|
1157
1661
|
limit: 56, # Integer |
|
1158
1662
|
starting_after: "starting_after_example", # String |
|
@@ -1160,10 +1664,10 @@ opts = {
|
|
1160
1664
|
}
|
1161
1665
|
|
1162
1666
|
begin
|
1163
|
-
result = api_instance.
|
1667
|
+
result = api_instance.get_sections(opts)
|
1164
1668
|
p result
|
1165
1669
|
rescue Clever::ApiError => e
|
1166
|
-
puts "Exception when calling DataApi->
|
1670
|
+
puts "Exception when calling DataApi->get_sections: #{e}"
|
1167
1671
|
end
|
1168
1672
|
```
|
1169
1673
|
|
@@ -1171,14 +1675,13 @@ end
|
|
1171
1675
|
|
1172
1676
|
Name | Type | Description | Notes
|
1173
1677
|
------------- | ------------- | ------------- | -------------
|
1174
|
-
**id** | **String**| |
|
1175
1678
|
**limit** | **Integer**| | [optional]
|
1176
1679
|
**starting_after** | **String**| | [optional]
|
1177
1680
|
**ending_before** | **String**| | [optional]
|
1178
1681
|
|
1179
1682
|
### Return type
|
1180
1683
|
|
1181
|
-
[**
|
1684
|
+
[**SectionsResponse**](SectionsResponse.md)
|
1182
1685
|
|
1183
1686
|
### Authorization
|
1184
1687
|
|
@@ -1191,12 +1694,12 @@ Name | Type | Description | Notes
|
|
1191
1694
|
|
1192
1695
|
|
1193
1696
|
|
1194
|
-
# **
|
1195
|
-
>
|
1697
|
+
# **get_sections_for_course**
|
1698
|
+
> SectionsResponse get_sections_for_course(id, opts)
|
1196
1699
|
|
1197
1700
|
|
1198
1701
|
|
1199
|
-
Returns a
|
1702
|
+
Returns the sections for a Courses
|
1200
1703
|
|
1201
1704
|
### Example
|
1202
1705
|
```ruby
|
@@ -1212,12 +1715,17 @@ api_instance = Clever::DataApi.new
|
|
1212
1715
|
|
1213
1716
|
id = "id_example" # String |
|
1214
1717
|
|
1718
|
+
opts = {
|
1719
|
+
limit: 56, # Integer |
|
1720
|
+
starting_after: "starting_after_example", # String |
|
1721
|
+
ending_before: "ending_before_example" # String |
|
1722
|
+
}
|
1215
1723
|
|
1216
1724
|
begin
|
1217
|
-
result = api_instance.
|
1725
|
+
result = api_instance.get_sections_for_course(id, opts)
|
1218
1726
|
p result
|
1219
1727
|
rescue Clever::ApiError => e
|
1220
|
-
puts "Exception when calling DataApi->
|
1728
|
+
puts "Exception when calling DataApi->get_sections_for_course: #{e}"
|
1221
1729
|
end
|
1222
1730
|
```
|
1223
1731
|
|
@@ -1226,10 +1734,13 @@ end
|
|
1226
1734
|
Name | Type | Description | Notes
|
1227
1735
|
------------- | ------------- | ------------- | -------------
|
1228
1736
|
**id** | **String**| |
|
1737
|
+
**limit** | **Integer**| | [optional]
|
1738
|
+
**starting_after** | **String**| | [optional]
|
1739
|
+
**ending_before** | **String**| | [optional]
|
1229
1740
|
|
1230
1741
|
### Return type
|
1231
1742
|
|
1232
|
-
[**
|
1743
|
+
[**SectionsResponse**](SectionsResponse.md)
|
1233
1744
|
|
1234
1745
|
### Authorization
|
1235
1746
|
|
@@ -1242,12 +1753,12 @@ Name | Type | Description | Notes
|
|
1242
1753
|
|
1243
1754
|
|
1244
1755
|
|
1245
|
-
# **
|
1246
|
-
> SectionsResponse
|
1756
|
+
# **get_sections_for_school**
|
1757
|
+
> SectionsResponse get_sections_for_school(id, opts)
|
1247
1758
|
|
1248
1759
|
|
1249
1760
|
|
1250
|
-
Returns
|
1761
|
+
Returns the sections for a school
|
1251
1762
|
|
1252
1763
|
### Example
|
1253
1764
|
```ruby
|
@@ -1261,6 +1772,8 @@ end
|
|
1261
1772
|
|
1262
1773
|
api_instance = Clever::DataApi.new
|
1263
1774
|
|
1775
|
+
id = "id_example" # String |
|
1776
|
+
|
1264
1777
|
opts = {
|
1265
1778
|
limit: 56, # Integer |
|
1266
1779
|
starting_after: "starting_after_example", # String |
|
@@ -1268,10 +1781,10 @@ opts = {
|
|
1268
1781
|
}
|
1269
1782
|
|
1270
1783
|
begin
|
1271
|
-
result = api_instance.
|
1784
|
+
result = api_instance.get_sections_for_school(id, opts)
|
1272
1785
|
p result
|
1273
1786
|
rescue Clever::ApiError => e
|
1274
|
-
puts "Exception when calling DataApi->
|
1787
|
+
puts "Exception when calling DataApi->get_sections_for_school: #{e}"
|
1275
1788
|
end
|
1276
1789
|
```
|
1277
1790
|
|
@@ -1279,6 +1792,7 @@ end
|
|
1279
1792
|
|
1280
1793
|
Name | Type | Description | Notes
|
1281
1794
|
------------- | ------------- | ------------- | -------------
|
1795
|
+
**id** | **String**| |
|
1282
1796
|
**limit** | **Integer**| | [optional]
|
1283
1797
|
**starting_after** | **String**| | [optional]
|
1284
1798
|
**ending_before** | **String**| | [optional]
|
@@ -1298,12 +1812,12 @@ Name | Type | Description | Notes
|
|
1298
1812
|
|
1299
1813
|
|
1300
1814
|
|
1301
|
-
# **
|
1302
|
-
> SectionsResponse
|
1815
|
+
# **get_sections_for_student**
|
1816
|
+
> SectionsResponse get_sections_for_student(id, opts)
|
1303
1817
|
|
1304
1818
|
|
1305
1819
|
|
1306
|
-
Returns the sections for a
|
1820
|
+
Returns the sections for a student
|
1307
1821
|
|
1308
1822
|
### Example
|
1309
1823
|
```ruby
|
@@ -1326,10 +1840,10 @@ opts = {
|
|
1326
1840
|
}
|
1327
1841
|
|
1328
1842
|
begin
|
1329
|
-
result = api_instance.
|
1843
|
+
result = api_instance.get_sections_for_student(id, opts)
|
1330
1844
|
p result
|
1331
1845
|
rescue Clever::ApiError => e
|
1332
|
-
puts "Exception when calling DataApi->
|
1846
|
+
puts "Exception when calling DataApi->get_sections_for_student: #{e}"
|
1333
1847
|
end
|
1334
1848
|
```
|
1335
1849
|
|
@@ -1357,12 +1871,12 @@ Name | Type | Description | Notes
|
|
1357
1871
|
|
1358
1872
|
|
1359
1873
|
|
1360
|
-
# **
|
1361
|
-
> SectionsResponse
|
1874
|
+
# **get_sections_for_teacher**
|
1875
|
+
> SectionsResponse get_sections_for_teacher(id, opts)
|
1362
1876
|
|
1363
1877
|
|
1364
1878
|
|
1365
|
-
Returns the sections for a
|
1879
|
+
Returns the sections for a teacher
|
1366
1880
|
|
1367
1881
|
### Example
|
1368
1882
|
```ruby
|
@@ -1385,10 +1899,10 @@ opts = {
|
|
1385
1899
|
}
|
1386
1900
|
|
1387
1901
|
begin
|
1388
|
-
result = api_instance.
|
1902
|
+
result = api_instance.get_sections_for_teacher(id, opts)
|
1389
1903
|
p result
|
1390
1904
|
rescue Clever::ApiError => e
|
1391
|
-
puts "Exception when calling DataApi->
|
1905
|
+
puts "Exception when calling DataApi->get_sections_for_teacher: #{e}"
|
1392
1906
|
end
|
1393
1907
|
```
|
1394
1908
|
|
@@ -1416,12 +1930,12 @@ Name | Type | Description | Notes
|
|
1416
1930
|
|
1417
1931
|
|
1418
1932
|
|
1419
|
-
# **
|
1420
|
-
> SectionsResponse
|
1933
|
+
# **get_sections_for_term**
|
1934
|
+
> SectionsResponse get_sections_for_term(id, opts)
|
1421
1935
|
|
1422
1936
|
|
1423
1937
|
|
1424
|
-
Returns the sections for a
|
1938
|
+
Returns the sections for a term
|
1425
1939
|
|
1426
1940
|
### Example
|
1427
1941
|
```ruby
|
@@ -1444,10 +1958,10 @@ opts = {
|
|
1444
1958
|
}
|
1445
1959
|
|
1446
1960
|
begin
|
1447
|
-
result = api_instance.
|
1961
|
+
result = api_instance.get_sections_for_term(id, opts)
|
1448
1962
|
p result
|
1449
1963
|
rescue Clever::ApiError => e
|
1450
|
-
puts "Exception when calling DataApi->
|
1964
|
+
puts "Exception when calling DataApi->get_sections_for_term: #{e}"
|
1451
1965
|
end
|
1452
1966
|
```
|
1453
1967
|
|
@@ -1526,12 +2040,12 @@ Name | Type | Description | Notes
|
|
1526
2040
|
|
1527
2041
|
|
1528
2042
|
|
1529
|
-
# **
|
1530
|
-
>
|
2043
|
+
# **get_students**
|
2044
|
+
> StudentsResponse get_students(opts)
|
1531
2045
|
|
1532
2046
|
|
1533
2047
|
|
1534
|
-
Returns
|
2048
|
+
Returns a list of students
|
1535
2049
|
|
1536
2050
|
### Example
|
1537
2051
|
```ruby
|
@@ -1545,14 +2059,17 @@ end
|
|
1545
2059
|
|
1546
2060
|
api_instance = Clever::DataApi.new
|
1547
2061
|
|
1548
|
-
|
1549
|
-
|
2062
|
+
opts = {
|
2063
|
+
limit: 56, # Integer |
|
2064
|
+
starting_after: "starting_after_example", # String |
|
2065
|
+
ending_before: "ending_before_example" # String |
|
2066
|
+
}
|
1550
2067
|
|
1551
2068
|
begin
|
1552
|
-
result = api_instance.
|
2069
|
+
result = api_instance.get_students(opts)
|
1553
2070
|
p result
|
1554
2071
|
rescue Clever::ApiError => e
|
1555
|
-
puts "Exception when calling DataApi->
|
2072
|
+
puts "Exception when calling DataApi->get_students: #{e}"
|
1556
2073
|
end
|
1557
2074
|
```
|
1558
2075
|
|
@@ -1560,11 +2077,13 @@ end
|
|
1560
2077
|
|
1561
2078
|
Name | Type | Description | Notes
|
1562
2079
|
------------- | ------------- | ------------- | -------------
|
1563
|
-
**
|
2080
|
+
**limit** | **Integer**| | [optional]
|
2081
|
+
**starting_after** | **String**| | [optional]
|
2082
|
+
**ending_before** | **String**| | [optional]
|
1564
2083
|
|
1565
2084
|
### Return type
|
1566
2085
|
|
1567
|
-
[**
|
2086
|
+
[**StudentsResponse**](StudentsResponse.md)
|
1568
2087
|
|
1569
2088
|
### Authorization
|
1570
2089
|
|
@@ -1577,12 +2096,12 @@ Name | Type | Description | Notes
|
|
1577
2096
|
|
1578
2097
|
|
1579
2098
|
|
1580
|
-
# **
|
1581
|
-
> StudentsResponse
|
2099
|
+
# **get_students_for_contact**
|
2100
|
+
> StudentsResponse get_students_for_contact(id, opts)
|
1582
2101
|
|
1583
2102
|
|
1584
2103
|
|
1585
|
-
Returns a
|
2104
|
+
Returns the students for a student contact
|
1586
2105
|
|
1587
2106
|
### Example
|
1588
2107
|
```ruby
|
@@ -1596,6 +2115,8 @@ end
|
|
1596
2115
|
|
1597
2116
|
api_instance = Clever::DataApi.new
|
1598
2117
|
|
2118
|
+
id = "id_example" # String |
|
2119
|
+
|
1599
2120
|
opts = {
|
1600
2121
|
limit: 56, # Integer |
|
1601
2122
|
starting_after: "starting_after_example", # String |
|
@@ -1603,10 +2124,10 @@ opts = {
|
|
1603
2124
|
}
|
1604
2125
|
|
1605
2126
|
begin
|
1606
|
-
result = api_instance.
|
2127
|
+
result = api_instance.get_students_for_contact(id, opts)
|
1607
2128
|
p result
|
1608
2129
|
rescue Clever::ApiError => e
|
1609
|
-
puts "Exception when calling DataApi->
|
2130
|
+
puts "Exception when calling DataApi->get_students_for_contact: #{e}"
|
1610
2131
|
end
|
1611
2132
|
```
|
1612
2133
|
|
@@ -1614,6 +2135,7 @@ end
|
|
1614
2135
|
|
1615
2136
|
Name | Type | Description | Notes
|
1616
2137
|
------------- | ------------- | ------------- | -------------
|
2138
|
+
**id** | **String**| |
|
1617
2139
|
**limit** | **Integer**| | [optional]
|
1618
2140
|
**starting_after** | **String**| | [optional]
|
1619
2141
|
**ending_before** | **String**| | [optional]
|
@@ -2145,3 +2667,161 @@ Name | Type | Description | Notes
|
|
2145
2667
|
|
2146
2668
|
|
2147
2669
|
|
2670
|
+
# **get_term**
|
2671
|
+
> TermResponse get_term(id)
|
2672
|
+
|
2673
|
+
|
2674
|
+
|
2675
|
+
Returns a specific term
|
2676
|
+
|
2677
|
+
### Example
|
2678
|
+
```ruby
|
2679
|
+
# load the gem
|
2680
|
+
require 'clever-ruby'
|
2681
|
+
# setup authorization
|
2682
|
+
Clever.configure do |config|
|
2683
|
+
# Configure OAuth2 access token for authorization: oauth
|
2684
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
2685
|
+
end
|
2686
|
+
|
2687
|
+
api_instance = Clever::DataApi.new
|
2688
|
+
|
2689
|
+
id = "id_example" # String |
|
2690
|
+
|
2691
|
+
|
2692
|
+
begin
|
2693
|
+
result = api_instance.get_term(id)
|
2694
|
+
p result
|
2695
|
+
rescue Clever::ApiError => e
|
2696
|
+
puts "Exception when calling DataApi->get_term: #{e}"
|
2697
|
+
end
|
2698
|
+
```
|
2699
|
+
|
2700
|
+
### Parameters
|
2701
|
+
|
2702
|
+
Name | Type | Description | Notes
|
2703
|
+
------------- | ------------- | ------------- | -------------
|
2704
|
+
**id** | **String**| |
|
2705
|
+
|
2706
|
+
### Return type
|
2707
|
+
|
2708
|
+
[**TermResponse**](TermResponse.md)
|
2709
|
+
|
2710
|
+
### Authorization
|
2711
|
+
|
2712
|
+
[oauth](../README.md#oauth)
|
2713
|
+
|
2714
|
+
### HTTP request headers
|
2715
|
+
|
2716
|
+
- **Content-Type**: Not defined
|
2717
|
+
- **Accept**: application/json
|
2718
|
+
|
2719
|
+
|
2720
|
+
|
2721
|
+
# **get_term_for_section**
|
2722
|
+
> TermResponse get_term_for_section(id)
|
2723
|
+
|
2724
|
+
|
2725
|
+
|
2726
|
+
Returns the term for a section
|
2727
|
+
|
2728
|
+
### Example
|
2729
|
+
```ruby
|
2730
|
+
# load the gem
|
2731
|
+
require 'clever-ruby'
|
2732
|
+
# setup authorization
|
2733
|
+
Clever.configure do |config|
|
2734
|
+
# Configure OAuth2 access token for authorization: oauth
|
2735
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
2736
|
+
end
|
2737
|
+
|
2738
|
+
api_instance = Clever::DataApi.new
|
2739
|
+
|
2740
|
+
id = "id_example" # String |
|
2741
|
+
|
2742
|
+
|
2743
|
+
begin
|
2744
|
+
result = api_instance.get_term_for_section(id)
|
2745
|
+
p result
|
2746
|
+
rescue Clever::ApiError => e
|
2747
|
+
puts "Exception when calling DataApi->get_term_for_section: #{e}"
|
2748
|
+
end
|
2749
|
+
```
|
2750
|
+
|
2751
|
+
### Parameters
|
2752
|
+
|
2753
|
+
Name | Type | Description | Notes
|
2754
|
+
------------- | ------------- | ------------- | -------------
|
2755
|
+
**id** | **String**| |
|
2756
|
+
|
2757
|
+
### Return type
|
2758
|
+
|
2759
|
+
[**TermResponse**](TermResponse.md)
|
2760
|
+
|
2761
|
+
### Authorization
|
2762
|
+
|
2763
|
+
[oauth](../README.md#oauth)
|
2764
|
+
|
2765
|
+
### HTTP request headers
|
2766
|
+
|
2767
|
+
- **Content-Type**: Not defined
|
2768
|
+
- **Accept**: application/json
|
2769
|
+
|
2770
|
+
|
2771
|
+
|
2772
|
+
# **get_terms**
|
2773
|
+
> TermsResponse get_terms(opts)
|
2774
|
+
|
2775
|
+
|
2776
|
+
|
2777
|
+
Returns a list of terms
|
2778
|
+
|
2779
|
+
### Example
|
2780
|
+
```ruby
|
2781
|
+
# load the gem
|
2782
|
+
require 'clever-ruby'
|
2783
|
+
# setup authorization
|
2784
|
+
Clever.configure do |config|
|
2785
|
+
# Configure OAuth2 access token for authorization: oauth
|
2786
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
2787
|
+
end
|
2788
|
+
|
2789
|
+
api_instance = Clever::DataApi.new
|
2790
|
+
|
2791
|
+
opts = {
|
2792
|
+
limit: 56, # Integer |
|
2793
|
+
starting_after: "starting_after_example", # String |
|
2794
|
+
ending_before: "ending_before_example" # String |
|
2795
|
+
}
|
2796
|
+
|
2797
|
+
begin
|
2798
|
+
result = api_instance.get_terms(opts)
|
2799
|
+
p result
|
2800
|
+
rescue Clever::ApiError => e
|
2801
|
+
puts "Exception when calling DataApi->get_terms: #{e}"
|
2802
|
+
end
|
2803
|
+
```
|
2804
|
+
|
2805
|
+
### Parameters
|
2806
|
+
|
2807
|
+
Name | Type | Description | Notes
|
2808
|
+
------------- | ------------- | ------------- | -------------
|
2809
|
+
**limit** | **Integer**| | [optional]
|
2810
|
+
**starting_after** | **String**| | [optional]
|
2811
|
+
**ending_before** | **String**| | [optional]
|
2812
|
+
|
2813
|
+
### Return type
|
2814
|
+
|
2815
|
+
[**TermsResponse**](TermsResponse.md)
|
2816
|
+
|
2817
|
+
### Authorization
|
2818
|
+
|
2819
|
+
[oauth](../README.md#oauth)
|
2820
|
+
|
2821
|
+
### HTTP request headers
|
2822
|
+
|
2823
|
+
- **Content-Type**: Not defined
|
2824
|
+
- **Accept**: application/json
|
2825
|
+
|
2826
|
+
|
2827
|
+
|