clever-ruby 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/README.md +78 -46
- data/clever-ruby-1.0.0.gem +0 -0
- data/docs/Credentials.md +8 -0
- data/docs/DataApi.md +130 -127
- data/docs/District.md +1 -1
- data/docs/DistrictAdmin.md +2 -2
- data/docs/DistrictStatus.md +5 -5
- data/docs/DistrictsCreated.md +2 -1
- data/docs/DistrictsDeleted.md +2 -1
- data/docs/DistrictsUpdated.md +2 -1
- data/docs/Event.md +2 -1
- data/docs/EventsApi.md +14 -21
- data/docs/Location.md +2 -2
- data/docs/Name.md +1 -1
- data/docs/Principal.md +1 -1
- data/docs/School.md +2 -2
- data/docs/SchoolAdmin.md +2 -1
- data/docs/SchooladminsCreated.md +2 -1
- data/docs/SchooladminsDeleted.md +2 -1
- data/docs/SchooladminsUpdated.md +2 -1
- data/docs/SchoolsCreated.md +2 -1
- data/docs/SchoolsDeleted.md +2 -1
- data/docs/SchoolsUpdated.md +2 -1
- data/docs/Section.md +1 -1
- data/docs/SectionsCreated.md +2 -1
- data/docs/SectionsDeleted.md +2 -1
- data/docs/SectionsUpdated.md +2 -1
- data/docs/Student.md +2 -2
- data/docs/StudentContact.md +1 -1
- data/docs/StudentcontactsCreated.md +2 -1
- data/docs/StudentcontactsDeleted.md +2 -1
- data/docs/StudentcontactsUpdated.md +2 -1
- data/docs/StudentsCreated.md +2 -1
- data/docs/StudentsDeleted.md +2 -1
- data/docs/StudentsUpdated.md +2 -1
- data/docs/Teacher.md +2 -1
- data/docs/TeachersCreated.md +2 -1
- data/docs/TeachersDeleted.md +2 -1
- data/docs/TeachersUpdated.md +2 -1
- data/docs/Term.md +1 -1
- data/lib/clever-ruby.rb +1 -0
- data/lib/clever-ruby/api/data_api.rb +127 -85
- data/lib/clever-ruby/api/events_api.rb +14 -14
- data/lib/clever-ruby/models/credentials.rb +187 -0
- data/lib/clever-ruby/models/district.rb +13 -13
- data/lib/clever-ruby/models/district_admin.rb +22 -22
- data/lib/clever-ruby/models/district_status.rb +70 -37
- data/lib/clever-ruby/models/event.rb +19 -10
- data/lib/clever-ruby/models/location.rb +22 -22
- data/lib/clever-ruby/models/name.rb +13 -13
- data/lib/clever-ruby/models/principal.rb +13 -13
- data/lib/clever-ruby/models/school.rb +66 -21
- data/lib/clever-ruby/models/school_admin.rb +16 -7
- data/lib/clever-ruby/models/section.rb +55 -10
- data/lib/clever-ruby/models/student.rb +100 -19
- data/lib/clever-ruby/models/student_contact.rb +10 -10
- data/lib/clever-ruby/models/teacher.rb +19 -10
- data/lib/clever-ruby/models/term.rb +13 -13
- data/lib/clever-ruby/version.rb +1 -1
- data/override/README-extension.md +31 -0
- data/override/config.json +1 -1
- data/override/override.sh +5 -0
- data/sample/sample.rb +1 -1
- metadata +6 -3
- data/instructions.md +0 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b4ab7eecb3756666bb0144d9b64011e9cd0879bb
|
4
|
+
data.tar.gz: caed6286d2eaec9c705220a1492ee2813e4373b6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bd012a3d4d3d5b55128b9449e3df053cc96d9fd81c5cf56177c959f11cb4e2772c8ab135c6830b90586e273d5bcad218e308f9733f37c4e03943b8ec2bac0857
|
7
|
+
data.tar.gz: 06a817069a54008b2f1f1207516dc6e5f766ddbc650de71d3ae181643938d90d2a88c2cbc29d862942e92283922f2821ee75ab8335f972090a1232071e293eca
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -66,7 +66,6 @@ id = "id_example" # String |
|
|
66
66
|
|
67
67
|
|
68
68
|
begin
|
69
|
-
#Get only a specific studentcontact's information.
|
70
69
|
result = api_instance.get_contact(id)
|
71
70
|
p result
|
72
71
|
rescue Clever::ApiError => e
|
@@ -81,56 +80,58 @@ All URIs are relative to *https://api.clever.com/v1.2*
|
|
81
80
|
|
82
81
|
Class | Method | HTTP request | Description
|
83
82
|
------------ | ------------- | ------------- | -------------
|
84
|
-
*Clever::DataApi* | [**get_contact**](docs/DataApi.md#get_contact) | **GET** /contacts/{id} |
|
85
|
-
*Clever::DataApi* | [**get_contacts**](docs/DataApi.md#get_contacts) | **GET** /contacts |
|
86
|
-
*Clever::DataApi* | [**get_contacts_for_student**](docs/DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
|
87
|
-
*Clever::DataApi* | [**get_district**](docs/DataApi.md#get_district) | **GET** /districts/{id} |
|
88
|
-
*Clever::DataApi* | [**get_district_admin**](docs/DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
|
89
|
-
*Clever::DataApi* | [**get_district_admins**](docs/DataApi.md#get_district_admins) | **GET** /district_admins |
|
90
|
-
*Clever::DataApi* | [**get_district_for_school**](docs/DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
|
91
|
-
*Clever::DataApi* | [**get_district_for_section**](docs/DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
|
92
|
-
*Clever::DataApi* | [**get_district_for_student**](docs/DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
|
93
|
-
*Clever::DataApi* | [**get_district_for_student_contact**](docs/DataApi.md#get_district_for_student_contact) | **GET** /contacts/{id}/district |
|
94
|
-
*Clever::DataApi* | [**get_district_for_teacher**](docs/DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
|
95
|
-
*Clever::DataApi* | [**
|
96
|
-
*Clever::DataApi* | [**
|
97
|
-
*Clever::DataApi* | [**
|
98
|
-
*Clever::DataApi* | [**
|
99
|
-
*Clever::DataApi* | [**
|
100
|
-
*Clever::DataApi* | [**
|
101
|
-
*Clever::DataApi* | [**
|
102
|
-
*Clever::DataApi* | [**
|
103
|
-
*Clever::DataApi* | [**
|
104
|
-
*Clever::DataApi* | [**
|
105
|
-
*Clever::DataApi* | [**
|
106
|
-
*Clever::DataApi* | [**
|
107
|
-
*Clever::DataApi* | [**
|
108
|
-
*Clever::DataApi* | [**
|
109
|
-
*Clever::DataApi* | [**
|
110
|
-
*Clever::DataApi* | [**
|
111
|
-
*Clever::DataApi* | [**
|
112
|
-
*Clever::DataApi* | [**
|
113
|
-
*Clever::DataApi* | [**
|
114
|
-
*Clever::DataApi* | [**
|
115
|
-
*Clever::DataApi* | [**
|
116
|
-
*Clever::DataApi* | [**
|
117
|
-
*Clever::DataApi* | [**
|
118
|
-
*Clever::DataApi* | [**
|
119
|
-
*Clever::DataApi* | [**
|
120
|
-
*Clever::DataApi* | [**
|
121
|
-
*Clever::DataApi* | [**
|
122
|
-
*Clever::
|
123
|
-
*Clever::EventsApi* | [**
|
124
|
-
*Clever::EventsApi* | [**
|
125
|
-
*Clever::EventsApi* | [**
|
126
|
-
*Clever::EventsApi* | [**
|
127
|
-
*Clever::EventsApi* | [**
|
128
|
-
*Clever::EventsApi* | [**
|
83
|
+
*Clever::DataApi* | [**get_contact**](docs/DataApi.md#get_contact) | **GET** /contacts/{id} |
|
84
|
+
*Clever::DataApi* | [**get_contacts**](docs/DataApi.md#get_contacts) | **GET** /contacts |
|
85
|
+
*Clever::DataApi* | [**get_contacts_for_student**](docs/DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
|
86
|
+
*Clever::DataApi* | [**get_district**](docs/DataApi.md#get_district) | **GET** /districts/{id} |
|
87
|
+
*Clever::DataApi* | [**get_district_admin**](docs/DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
|
88
|
+
*Clever::DataApi* | [**get_district_admins**](docs/DataApi.md#get_district_admins) | **GET** /district_admins |
|
89
|
+
*Clever::DataApi* | [**get_district_for_school**](docs/DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
|
90
|
+
*Clever::DataApi* | [**get_district_for_section**](docs/DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
|
91
|
+
*Clever::DataApi* | [**get_district_for_student**](docs/DataApi.md#get_district_for_student) | **GET** /students/{id}/district |
|
92
|
+
*Clever::DataApi* | [**get_district_for_student_contact**](docs/DataApi.md#get_district_for_student_contact) | **GET** /contacts/{id}/district |
|
93
|
+
*Clever::DataApi* | [**get_district_for_teacher**](docs/DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
|
94
|
+
*Clever::DataApi* | [**get_district_status**](docs/DataApi.md#get_district_status) | **GET** /districts/{id}/status |
|
95
|
+
*Clever::DataApi* | [**get_districts**](docs/DataApi.md#get_districts) | **GET** /districts |
|
96
|
+
*Clever::DataApi* | [**get_grade_levels_for_teacher**](docs/DataApi.md#get_grade_levels_for_teacher) | **GET** /teachers/{id}/grade_levels |
|
97
|
+
*Clever::DataApi* | [**get_school**](docs/DataApi.md#get_school) | **GET** /schools/{id} |
|
98
|
+
*Clever::DataApi* | [**get_school_admin**](docs/DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
|
99
|
+
*Clever::DataApi* | [**get_school_admins**](docs/DataApi.md#get_school_admins) | **GET** /school_admins |
|
100
|
+
*Clever::DataApi* | [**get_school_for_section**](docs/DataApi.md#get_school_for_section) | **GET** /sections/{id}/school |
|
101
|
+
*Clever::DataApi* | [**get_school_for_student**](docs/DataApi.md#get_school_for_student) | **GET** /students/{id}/school |
|
102
|
+
*Clever::DataApi* | [**get_school_for_teacher**](docs/DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
|
103
|
+
*Clever::DataApi* | [**get_schools**](docs/DataApi.md#get_schools) | **GET** /schools |
|
104
|
+
*Clever::DataApi* | [**get_schools_for_school_admin**](docs/DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
|
105
|
+
*Clever::DataApi* | [**get_section**](docs/DataApi.md#get_section) | **GET** /sections/{id} |
|
106
|
+
*Clever::DataApi* | [**get_sections**](docs/DataApi.md#get_sections) | **GET** /sections |
|
107
|
+
*Clever::DataApi* | [**get_sections_for_school**](docs/DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
|
108
|
+
*Clever::DataApi* | [**get_sections_for_student**](docs/DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
|
109
|
+
*Clever::DataApi* | [**get_sections_for_teacher**](docs/DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
|
110
|
+
*Clever::DataApi* | [**get_student**](docs/DataApi.md#get_student) | **GET** /students/{id} |
|
111
|
+
*Clever::DataApi* | [**get_student_for_contact**](docs/DataApi.md#get_student_for_contact) | **GET** /contacts/{id}/student |
|
112
|
+
*Clever::DataApi* | [**get_students**](docs/DataApi.md#get_students) | **GET** /students |
|
113
|
+
*Clever::DataApi* | [**get_students_for_school**](docs/DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
|
114
|
+
*Clever::DataApi* | [**get_students_for_section**](docs/DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
|
115
|
+
*Clever::DataApi* | [**get_students_for_teacher**](docs/DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
|
116
|
+
*Clever::DataApi* | [**get_teacher**](docs/DataApi.md#get_teacher) | **GET** /teachers/{id} |
|
117
|
+
*Clever::DataApi* | [**get_teacher_for_section**](docs/DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
|
118
|
+
*Clever::DataApi* | [**get_teachers**](docs/DataApi.md#get_teachers) | **GET** /teachers |
|
119
|
+
*Clever::DataApi* | [**get_teachers_for_school**](docs/DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
|
120
|
+
*Clever::DataApi* | [**get_teachers_for_section**](docs/DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
|
121
|
+
*Clever::DataApi* | [**get_teachers_for_student**](docs/DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
|
122
|
+
*Clever::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} |
|
123
|
+
*Clever::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events |
|
124
|
+
*Clever::EventsApi* | [**get_events_for_school**](docs/EventsApi.md#get_events_for_school) | **GET** /schools/{id}/events |
|
125
|
+
*Clever::EventsApi* | [**get_events_for_school_admin**](docs/EventsApi.md#get_events_for_school_admin) | **GET** /school_admins/{id}/events |
|
126
|
+
*Clever::EventsApi* | [**get_events_for_section**](docs/EventsApi.md#get_events_for_section) | **GET** /sections/{id}/events |
|
127
|
+
*Clever::EventsApi* | [**get_events_for_student**](docs/EventsApi.md#get_events_for_student) | **GET** /students/{id}/events |
|
128
|
+
*Clever::EventsApi* | [**get_events_for_teacher**](docs/EventsApi.md#get_events_for_teacher) | **GET** /teachers/{id}/events |
|
129
129
|
|
130
130
|
|
131
131
|
## Documentation for Models
|
132
132
|
|
133
133
|
- [Clever::BadRequest](docs/BadRequest.md)
|
134
|
+
- [Clever::Credentials](docs/Credentials.md)
|
134
135
|
- [Clever::District](docs/District.md)
|
135
136
|
- [Clever::DistrictAdmin](docs/DistrictAdmin.md)
|
136
137
|
- [Clever::DistrictAdminResponse](docs/DistrictAdminResponse.md)
|
@@ -207,3 +208,34 @@ Class | Method | HTTP request | Description
|
|
207
208
|
- **Authorization URL**: https://clever.com/oauth/authorize
|
208
209
|
- **Scopes**: N/A
|
209
210
|
|
211
|
+
## Previous Versions
|
212
|
+
|
213
|
+
The current client support v1.2 of the API. For v1.1 please use:
|
214
|
+
|
215
|
+
https://rubygems.org/gems/clever-ruby/versions/0.14.0
|
216
|
+
https://github.com/Clever/clever-ruby/tree/0.14
|
217
|
+
|
218
|
+
|
219
|
+
## Updating the Library
|
220
|
+
|
221
|
+
1. Git clone swagger-codegen (https://github.com/swagger-api/swagger-codegen)
|
222
|
+
|
223
|
+
2. Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)
|
224
|
+
|
225
|
+
3. Run this command in the swagger-codegen repo
|
226
|
+
```
|
227
|
+
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v1.2-client.yml -c $PATH_TO_THIS_REPO/override/config.json -l ruby -o $PATH_TO_THIS_REPO
|
228
|
+
```
|
229
|
+
|
230
|
+
4. Run `make build` to copy over the override files
|
231
|
+
|
232
|
+
|
233
|
+
## Publishing
|
234
|
+
|
235
|
+
Signup to rubygems.org if you don't already have an account, and ask one of the gem [owners](https://rubygems.org/gems/clever-ruby) to add you as an owner. You'll be prompted to log in from the command line when you push the gem, if you aren't already logged in.
|
236
|
+
|
237
|
+
To add a new owner, you need to be an owner, then run this command: `gem owner clever-ruby -a <emailaddress>`
|
238
|
+
|
239
|
+
1. Update `CHANGELOG.md`
|
240
|
+
1. `gem build clever-ruby.gemspec`
|
241
|
+
1. `gem push clever-ruby-X.Y.Z.gem`
|
Binary file
|
data/docs/Credentials.md
ADDED
data/docs/DataApi.md
CHANGED
@@ -4,50 +4,51 @@ All URIs are relative to *https://api.clever.com/v1.2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} |
|
8
|
-
[**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts |
|
9
|
-
[**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
|
10
|
-
[**get_district**](DataApi.md#get_district) | **GET** /districts/{id} |
|
11
|
-
[**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
|
12
|
-
[**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins |
|
13
|
-
[**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
|
14
|
-
[**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
|
15
|
-
[**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
|
-
[**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
|
18
|
-
[**
|
19
|
-
[**
|
20
|
-
[**
|
21
|
-
[**
|
22
|
-
[**
|
23
|
-
[**
|
24
|
-
[**
|
25
|
-
[**
|
26
|
-
[**
|
27
|
-
[**
|
28
|
-
[**
|
29
|
-
[**
|
30
|
-
[**
|
31
|
-
[**
|
32
|
-
[**
|
33
|
-
[**
|
34
|
-
[**
|
35
|
-
[**
|
36
|
-
[**
|
37
|
-
[**
|
38
|
-
[**
|
39
|
-
[**
|
40
|
-
[**
|
41
|
-
[**
|
42
|
-
[**
|
43
|
-
[**
|
44
|
-
[**
|
7
|
+
[**get_contact**](DataApi.md#get_contact) | **GET** /contacts/{id} |
|
8
|
+
[**get_contacts**](DataApi.md#get_contacts) | **GET** /contacts |
|
9
|
+
[**get_contacts_for_student**](DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts |
|
10
|
+
[**get_district**](DataApi.md#get_district) | **GET** /districts/{id} |
|
11
|
+
[**get_district_admin**](DataApi.md#get_district_admin) | **GET** /district_admins/{id} |
|
12
|
+
[**get_district_admins**](DataApi.md#get_district_admins) | **GET** /district_admins |
|
13
|
+
[**get_district_for_school**](DataApi.md#get_district_for_school) | **GET** /schools/{id}/district |
|
14
|
+
[**get_district_for_section**](DataApi.md#get_district_for_section) | **GET** /sections/{id}/district |
|
15
|
+
[**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
|
+
[**get_district_for_teacher**](DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district |
|
18
|
+
[**get_district_status**](DataApi.md#get_district_status) | **GET** /districts/{id}/status |
|
19
|
+
[**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
|
+
[**get_school**](DataApi.md#get_school) | **GET** /schools/{id} |
|
22
|
+
[**get_school_admin**](DataApi.md#get_school_admin) | **GET** /school_admins/{id} |
|
23
|
+
[**get_school_admins**](DataApi.md#get_school_admins) | **GET** /school_admins |
|
24
|
+
[**get_school_for_section**](DataApi.md#get_school_for_section) | **GET** /sections/{id}/school |
|
25
|
+
[**get_school_for_student**](DataApi.md#get_school_for_student) | **GET** /students/{id}/school |
|
26
|
+
[**get_school_for_teacher**](DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school |
|
27
|
+
[**get_schools**](DataApi.md#get_schools) | **GET** /schools |
|
28
|
+
[**get_schools_for_school_admin**](DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools |
|
29
|
+
[**get_section**](DataApi.md#get_section) | **GET** /sections/{id} |
|
30
|
+
[**get_sections**](DataApi.md#get_sections) | **GET** /sections |
|
31
|
+
[**get_sections_for_school**](DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections |
|
32
|
+
[**get_sections_for_student**](DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections |
|
33
|
+
[**get_sections_for_teacher**](DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections |
|
34
|
+
[**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
|
+
[**get_students**](DataApi.md#get_students) | **GET** /students |
|
37
|
+
[**get_students_for_school**](DataApi.md#get_students_for_school) | **GET** /schools/{id}/students |
|
38
|
+
[**get_students_for_section**](DataApi.md#get_students_for_section) | **GET** /sections/{id}/students |
|
39
|
+
[**get_students_for_teacher**](DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students |
|
40
|
+
[**get_teacher**](DataApi.md#get_teacher) | **GET** /teachers/{id} |
|
41
|
+
[**get_teacher_for_section**](DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher |
|
42
|
+
[**get_teachers**](DataApi.md#get_teachers) | **GET** /teachers |
|
43
|
+
[**get_teachers_for_school**](DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers |
|
44
|
+
[**get_teachers_for_section**](DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers |
|
45
|
+
[**get_teachers_for_student**](DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers |
|
45
46
|
|
46
47
|
|
47
48
|
# **get_contact**
|
48
49
|
> StudentContactResponse get_contact(id)
|
49
50
|
|
50
|
-
|
51
|
+
|
51
52
|
|
52
53
|
Returns a specific student contact
|
53
54
|
|
@@ -67,7 +68,6 @@ id = "id_example" # String |
|
|
67
68
|
|
68
69
|
|
69
70
|
begin
|
70
|
-
#Get only a specific studentcontact's information.
|
71
71
|
result = api_instance.get_contact(id)
|
72
72
|
p result
|
73
73
|
rescue Clever::ApiError => e
|
@@ -99,7 +99,7 @@ Name | Type | Description | Notes
|
|
99
99
|
# **get_contacts**
|
100
100
|
> StudentContactsResponse get_contacts(opts)
|
101
101
|
|
102
|
-
|
102
|
+
|
103
103
|
|
104
104
|
Returns a list of student contacts
|
105
105
|
|
@@ -122,7 +122,6 @@ opts = {
|
|
122
122
|
}
|
123
123
|
|
124
124
|
begin
|
125
|
-
#Gets a list of student contacts you have access to.
|
126
125
|
result = api_instance.get_contacts(opts)
|
127
126
|
p result
|
128
127
|
rescue Clever::ApiError => e
|
@@ -156,7 +155,7 @@ Name | Type | Description | Notes
|
|
156
155
|
# **get_contacts_for_student**
|
157
156
|
> StudentContactsResponse get_contacts_for_student(id, opts)
|
158
157
|
|
159
|
-
|
158
|
+
|
160
159
|
|
161
160
|
Returns the contacts for a student
|
162
161
|
|
@@ -179,7 +178,6 @@ opts = {
|
|
179
178
|
}
|
180
179
|
|
181
180
|
begin
|
182
|
-
#Retrieves all contacts for a student.
|
183
181
|
result = api_instance.get_contacts_for_student(id, opts)
|
184
182
|
p result
|
185
183
|
rescue Clever::ApiError => e
|
@@ -212,7 +210,7 @@ Name | Type | Description | Notes
|
|
212
210
|
# **get_district**
|
213
211
|
> DistrictResponse get_district(id)
|
214
212
|
|
215
|
-
|
213
|
+
|
216
214
|
|
217
215
|
Returns a specific district
|
218
216
|
|
@@ -232,7 +230,6 @@ id = "id_example" # String |
|
|
232
230
|
|
233
231
|
|
234
232
|
begin
|
235
|
-
#Get only a specific district's information.
|
236
233
|
result = api_instance.get_district(id)
|
237
234
|
p result
|
238
235
|
rescue Clever::ApiError => e
|
@@ -264,7 +261,7 @@ Name | Type | Description | Notes
|
|
264
261
|
# **get_district_admin**
|
265
262
|
> DistrictAdminResponse get_district_admin(id)
|
266
263
|
|
267
|
-
|
264
|
+
|
268
265
|
|
269
266
|
Returns a specific district admin
|
270
267
|
|
@@ -284,7 +281,6 @@ id = "id_example" # String |
|
|
284
281
|
|
285
282
|
|
286
283
|
begin
|
287
|
-
#Retrieves a district admin
|
288
284
|
result = api_instance.get_district_admin(id)
|
289
285
|
p result
|
290
286
|
rescue Clever::ApiError => e
|
@@ -316,7 +312,7 @@ Name | Type | Description | Notes
|
|
316
312
|
# **get_district_admins**
|
317
313
|
> DistrictAdminsResponse get_district_admins(opts)
|
318
314
|
|
319
|
-
|
315
|
+
|
320
316
|
|
321
317
|
Returns a list of district admins
|
322
318
|
|
@@ -338,7 +334,6 @@ opts = {
|
|
338
334
|
}
|
339
335
|
|
340
336
|
begin
|
341
|
-
#Retrieves all users with admin access to a district.
|
342
337
|
result = api_instance.get_district_admins(opts)
|
343
338
|
p result
|
344
339
|
rescue Clever::ApiError => e
|
@@ -371,7 +366,7 @@ Name | Type | Description | Notes
|
|
371
366
|
# **get_district_for_school**
|
372
367
|
> DistrictResponse get_district_for_school(id)
|
373
368
|
|
374
|
-
|
369
|
+
|
375
370
|
|
376
371
|
Returns the district for a school
|
377
372
|
|
@@ -391,7 +386,6 @@ id = "id_example" # String |
|
|
391
386
|
|
392
387
|
|
393
388
|
begin
|
394
|
-
#Retrieves district information for a school.
|
395
389
|
result = api_instance.get_district_for_school(id)
|
396
390
|
p result
|
397
391
|
rescue Clever::ApiError => e
|
@@ -423,7 +417,7 @@ Name | Type | Description | Notes
|
|
423
417
|
# **get_district_for_section**
|
424
418
|
> DistrictResponse get_district_for_section(id)
|
425
419
|
|
426
|
-
|
420
|
+
|
427
421
|
|
428
422
|
Returns the district for a section
|
429
423
|
|
@@ -443,7 +437,6 @@ id = "id_example" # String |
|
|
443
437
|
|
444
438
|
|
445
439
|
begin
|
446
|
-
#Retrieves district information for a section.
|
447
440
|
result = api_instance.get_district_for_section(id)
|
448
441
|
p result
|
449
442
|
rescue Clever::ApiError => e
|
@@ -475,7 +468,7 @@ Name | Type | Description | Notes
|
|
475
468
|
# **get_district_for_student**
|
476
469
|
> DistrictResponse get_district_for_student(id)
|
477
470
|
|
478
|
-
|
471
|
+
|
479
472
|
|
480
473
|
Returns the district for a student
|
481
474
|
|
@@ -495,7 +488,6 @@ id = "id_example" # String |
|
|
495
488
|
|
496
489
|
|
497
490
|
begin
|
498
|
-
#Retrieves district information for a student.
|
499
491
|
result = api_instance.get_district_for_student(id)
|
500
492
|
p result
|
501
493
|
rescue Clever::ApiError => e
|
@@ -527,7 +519,7 @@ Name | Type | Description | Notes
|
|
527
519
|
# **get_district_for_student_contact**
|
528
520
|
> DistrictResponse get_district_for_student_contact(id)
|
529
521
|
|
530
|
-
|
522
|
+
|
531
523
|
|
532
524
|
Returns the district for a student contact
|
533
525
|
|
@@ -547,7 +539,6 @@ id = "id_example" # String |
|
|
547
539
|
|
548
540
|
|
549
541
|
begin
|
550
|
-
#Retrieves the district for a contact.
|
551
542
|
result = api_instance.get_district_for_student_contact(id)
|
552
543
|
p result
|
553
544
|
rescue Clever::ApiError => e
|
@@ -579,7 +570,7 @@ Name | Type | Description | Notes
|
|
579
570
|
# **get_district_for_teacher**
|
580
571
|
> DistrictResponse get_district_for_teacher(id)
|
581
572
|
|
582
|
-
|
573
|
+
|
583
574
|
|
584
575
|
Returns the district for a teacher
|
585
576
|
|
@@ -599,7 +590,6 @@ id = "id_example" # String |
|
|
599
590
|
|
600
591
|
|
601
592
|
begin
|
602
|
-
#Retrieves district information for a teacher.
|
603
593
|
result = api_instance.get_district_for_teacher(id)
|
604
594
|
p result
|
605
595
|
rescue Clever::ApiError => e
|
@@ -628,12 +618,12 @@ Name | Type | Description | Notes
|
|
628
618
|
|
629
619
|
|
630
620
|
|
631
|
-
# **
|
632
|
-
>
|
621
|
+
# **get_district_status**
|
622
|
+
> DistrictStatusResponse get_district_status(id)
|
633
623
|
|
634
|
-
Gets a list of districts you have access to.
|
635
624
|
|
636
|
-
|
625
|
+
|
626
|
+
Returns the status of the district
|
637
627
|
|
638
628
|
### Example
|
639
629
|
```ruby
|
@@ -647,18 +637,14 @@ end
|
|
647
637
|
|
648
638
|
api_instance = Clever::DataApi.new
|
649
639
|
|
650
|
-
|
651
|
-
|
652
|
-
starting_after: "starting_after_example", # String |
|
653
|
-
ending_before: "ending_before_example" # String |
|
654
|
-
}
|
640
|
+
id = "id_example" # String |
|
641
|
+
|
655
642
|
|
656
643
|
begin
|
657
|
-
|
658
|
-
result = api_instance.get_districts(opts)
|
644
|
+
result = api_instance.get_district_status(id)
|
659
645
|
p result
|
660
646
|
rescue Clever::ApiError => e
|
661
|
-
puts "Exception when calling DataApi->
|
647
|
+
puts "Exception when calling DataApi->get_district_status: #{e}"
|
662
648
|
end
|
663
649
|
```
|
664
650
|
|
@@ -666,9 +652,52 @@ end
|
|
666
652
|
|
667
653
|
Name | Type | Description | Notes
|
668
654
|
------------- | ------------- | ------------- | -------------
|
669
|
-
**
|
670
|
-
|
671
|
-
|
655
|
+
**id** | **String**| |
|
656
|
+
|
657
|
+
### Return type
|
658
|
+
|
659
|
+
[**DistrictStatusResponse**](DistrictStatusResponse.md)
|
660
|
+
|
661
|
+
### Authorization
|
662
|
+
|
663
|
+
[oauth](../README.md#oauth)
|
664
|
+
|
665
|
+
### HTTP request headers
|
666
|
+
|
667
|
+
- **Content-Type**: Not defined
|
668
|
+
- **Accept**: application/json
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
# **get_districts**
|
673
|
+
> DistrictsResponse get_districts
|
674
|
+
|
675
|
+
|
676
|
+
|
677
|
+
Returns a list of districts
|
678
|
+
|
679
|
+
### Example
|
680
|
+
```ruby
|
681
|
+
# load the gem
|
682
|
+
require 'clever-ruby'
|
683
|
+
# setup authorization
|
684
|
+
Clever.configure do |config|
|
685
|
+
# Configure OAuth2 access token for authorization: oauth
|
686
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
687
|
+
end
|
688
|
+
|
689
|
+
api_instance = Clever::DataApi.new
|
690
|
+
|
691
|
+
begin
|
692
|
+
result = api_instance.get_districts
|
693
|
+
p result
|
694
|
+
rescue Clever::ApiError => e
|
695
|
+
puts "Exception when calling DataApi->get_districts: #{e}"
|
696
|
+
end
|
697
|
+
```
|
698
|
+
|
699
|
+
### Parameters
|
700
|
+
This endpoint does not need any parameter.
|
672
701
|
|
673
702
|
### Return type
|
674
703
|
|
@@ -688,7 +717,7 @@ Name | Type | Description | Notes
|
|
688
717
|
# **get_grade_levels_for_teacher**
|
689
718
|
> GradeLevelsResponse get_grade_levels_for_teacher(id)
|
690
719
|
|
691
|
-
|
720
|
+
|
692
721
|
|
693
722
|
Returns the grade levels for sections a teacher teaches
|
694
723
|
|
@@ -708,7 +737,6 @@ id = "id_example" # String |
|
|
708
737
|
|
709
738
|
|
710
739
|
begin
|
711
|
-
#Retrieves a list of all grade levels taught by a specific teacher.
|
712
740
|
result = api_instance.get_grade_levels_for_teacher(id)
|
713
741
|
p result
|
714
742
|
rescue Clever::ApiError => e
|
@@ -740,7 +768,7 @@ Name | Type | Description | Notes
|
|
740
768
|
# **get_school**
|
741
769
|
> SchoolResponse get_school(id)
|
742
770
|
|
743
|
-
|
771
|
+
|
744
772
|
|
745
773
|
Returns a specific school
|
746
774
|
|
@@ -760,7 +788,6 @@ id = "id_example" # String |
|
|
760
788
|
|
761
789
|
|
762
790
|
begin
|
763
|
-
#Get only a specific school's information.
|
764
791
|
result = api_instance.get_school(id)
|
765
792
|
p result
|
766
793
|
rescue Clever::ApiError => e
|
@@ -792,7 +819,7 @@ Name | Type | Description | Notes
|
|
792
819
|
# **get_school_admin**
|
793
820
|
> SchoolAdminResponse get_school_admin(id)
|
794
821
|
|
795
|
-
|
822
|
+
|
796
823
|
|
797
824
|
Returns a specific school admin
|
798
825
|
|
@@ -812,7 +839,6 @@ id = "id_example" # String |
|
|
812
839
|
|
813
840
|
|
814
841
|
begin
|
815
|
-
#Get only a specific schooladmin's information.
|
816
842
|
result = api_instance.get_school_admin(id)
|
817
843
|
p result
|
818
844
|
rescue Clever::ApiError => e
|
@@ -844,7 +870,7 @@ Name | Type | Description | Notes
|
|
844
870
|
# **get_school_admins**
|
845
871
|
> SchoolAdminsResponse get_school_admins(opts)
|
846
872
|
|
847
|
-
|
873
|
+
|
848
874
|
|
849
875
|
Returns a list of school admins
|
850
876
|
|
@@ -867,7 +893,6 @@ opts = {
|
|
867
893
|
}
|
868
894
|
|
869
895
|
begin
|
870
|
-
#Gets a list of school_admins you have access to.
|
871
896
|
result = api_instance.get_school_admins(opts)
|
872
897
|
p result
|
873
898
|
rescue Clever::ApiError => e
|
@@ -901,7 +926,7 @@ Name | Type | Description | Notes
|
|
901
926
|
# **get_school_for_section**
|
902
927
|
> SchoolResponse get_school_for_section(id)
|
903
928
|
|
904
|
-
|
929
|
+
|
905
930
|
|
906
931
|
Returns the school for a section
|
907
932
|
|
@@ -921,7 +946,6 @@ id = "id_example" # String |
|
|
921
946
|
|
922
947
|
|
923
948
|
begin
|
924
|
-
#Retrieves information about the school for a section
|
925
949
|
result = api_instance.get_school_for_section(id)
|
926
950
|
p result
|
927
951
|
rescue Clever::ApiError => e
|
@@ -953,7 +977,7 @@ Name | Type | Description | Notes
|
|
953
977
|
# **get_school_for_student**
|
954
978
|
> SchoolResponse get_school_for_student(id)
|
955
979
|
|
956
|
-
|
980
|
+
|
957
981
|
|
958
982
|
Returns the primary school for a student
|
959
983
|
|
@@ -973,7 +997,6 @@ id = "id_example" # String |
|
|
973
997
|
|
974
998
|
|
975
999
|
begin
|
976
|
-
#Retrieves information about the school for a student
|
977
1000
|
result = api_instance.get_school_for_student(id)
|
978
1001
|
p result
|
979
1002
|
rescue Clever::ApiError => e
|
@@ -1005,7 +1028,7 @@ Name | Type | Description | Notes
|
|
1005
1028
|
# **get_school_for_teacher**
|
1006
1029
|
> SchoolResponse get_school_for_teacher(id)
|
1007
1030
|
|
1008
|
-
|
1031
|
+
|
1009
1032
|
|
1010
1033
|
Retrieves school info for a teacher.
|
1011
1034
|
|
@@ -1025,7 +1048,6 @@ id = "id_example" # String |
|
|
1025
1048
|
|
1026
1049
|
|
1027
1050
|
begin
|
1028
|
-
#Retrieves information about the school for a teacher
|
1029
1051
|
result = api_instance.get_school_for_teacher(id)
|
1030
1052
|
p result
|
1031
1053
|
rescue Clever::ApiError => e
|
@@ -1057,7 +1079,7 @@ Name | Type | Description | Notes
|
|
1057
1079
|
# **get_schools**
|
1058
1080
|
> SchoolsResponse get_schools(opts)
|
1059
1081
|
|
1060
|
-
|
1082
|
+
|
1061
1083
|
|
1062
1084
|
Returns a list of schools
|
1063
1085
|
|
@@ -1080,7 +1102,6 @@ opts = {
|
|
1080
1102
|
}
|
1081
1103
|
|
1082
1104
|
begin
|
1083
|
-
#Gets a list of schools you have access to.
|
1084
1105
|
result = api_instance.get_schools(opts)
|
1085
1106
|
p result
|
1086
1107
|
rescue Clever::ApiError => e
|
@@ -1114,7 +1135,7 @@ Name | Type | Description | Notes
|
|
1114
1135
|
# **get_schools_for_school_admin**
|
1115
1136
|
> SchoolsResponse get_schools_for_school_admin(id, opts)
|
1116
1137
|
|
1117
|
-
|
1138
|
+
|
1118
1139
|
|
1119
1140
|
Returns the schools for a school admin
|
1120
1141
|
|
@@ -1139,7 +1160,6 @@ opts = {
|
|
1139
1160
|
}
|
1140
1161
|
|
1141
1162
|
begin
|
1142
|
-
#Retrieves all schools for a school admin.
|
1143
1163
|
result = api_instance.get_schools_for_school_admin(id, opts)
|
1144
1164
|
p result
|
1145
1165
|
rescue Clever::ApiError => e
|
@@ -1174,7 +1194,7 @@ Name | Type | Description | Notes
|
|
1174
1194
|
# **get_section**
|
1175
1195
|
> SectionResponse get_section(id)
|
1176
1196
|
|
1177
|
-
|
1197
|
+
|
1178
1198
|
|
1179
1199
|
Returns a specific section
|
1180
1200
|
|
@@ -1194,7 +1214,6 @@ id = "id_example" # String |
|
|
1194
1214
|
|
1195
1215
|
|
1196
1216
|
begin
|
1197
|
-
#Get only a specific section's information.
|
1198
1217
|
result = api_instance.get_section(id)
|
1199
1218
|
p result
|
1200
1219
|
rescue Clever::ApiError => e
|
@@ -1226,7 +1245,7 @@ Name | Type | Description | Notes
|
|
1226
1245
|
# **get_sections**
|
1227
1246
|
> SectionsResponse get_sections(opts)
|
1228
1247
|
|
1229
|
-
|
1248
|
+
|
1230
1249
|
|
1231
1250
|
Returns a list of sections
|
1232
1251
|
|
@@ -1249,7 +1268,6 @@ opts = {
|
|
1249
1268
|
}
|
1250
1269
|
|
1251
1270
|
begin
|
1252
|
-
#Gets a list of sections you have access to.
|
1253
1271
|
result = api_instance.get_sections(opts)
|
1254
1272
|
p result
|
1255
1273
|
rescue Clever::ApiError => e
|
@@ -1283,7 +1301,7 @@ Name | Type | Description | Notes
|
|
1283
1301
|
# **get_sections_for_school**
|
1284
1302
|
> SectionsResponse get_sections_for_school(id, opts)
|
1285
1303
|
|
1286
|
-
|
1304
|
+
|
1287
1305
|
|
1288
1306
|
Returns the sections for a school
|
1289
1307
|
|
@@ -1308,7 +1326,6 @@ opts = {
|
|
1308
1326
|
}
|
1309
1327
|
|
1310
1328
|
begin
|
1311
|
-
#Retrieves a list of all sections for a specific school.
|
1312
1329
|
result = api_instance.get_sections_for_school(id, opts)
|
1313
1330
|
p result
|
1314
1331
|
rescue Clever::ApiError => e
|
@@ -1343,7 +1360,7 @@ Name | Type | Description | Notes
|
|
1343
1360
|
# **get_sections_for_student**
|
1344
1361
|
> SectionsResponse get_sections_for_student(id, opts)
|
1345
1362
|
|
1346
|
-
|
1363
|
+
|
1347
1364
|
|
1348
1365
|
Returns the sections for a student
|
1349
1366
|
|
@@ -1368,7 +1385,6 @@ opts = {
|
|
1368
1385
|
}
|
1369
1386
|
|
1370
1387
|
begin
|
1371
|
-
#Retrieves a list of all sections for a student.
|
1372
1388
|
result = api_instance.get_sections_for_student(id, opts)
|
1373
1389
|
p result
|
1374
1390
|
rescue Clever::ApiError => e
|
@@ -1403,7 +1419,7 @@ Name | Type | Description | Notes
|
|
1403
1419
|
# **get_sections_for_teacher**
|
1404
1420
|
> SectionsResponse get_sections_for_teacher(id, opts)
|
1405
1421
|
|
1406
|
-
|
1422
|
+
|
1407
1423
|
|
1408
1424
|
Returns the sections for a teacher
|
1409
1425
|
|
@@ -1428,7 +1444,6 @@ opts = {
|
|
1428
1444
|
}
|
1429
1445
|
|
1430
1446
|
begin
|
1431
|
-
#Retrieves a list of all sections for a teacher.
|
1432
1447
|
result = api_instance.get_sections_for_teacher(id, opts)
|
1433
1448
|
p result
|
1434
1449
|
rescue Clever::ApiError => e
|
@@ -1463,7 +1478,7 @@ Name | Type | Description | Notes
|
|
1463
1478
|
# **get_student**
|
1464
1479
|
> StudentResponse get_student(id)
|
1465
1480
|
|
1466
|
-
|
1481
|
+
|
1467
1482
|
|
1468
1483
|
Returns a specific student
|
1469
1484
|
|
@@ -1483,7 +1498,6 @@ id = "id_example" # String |
|
|
1483
1498
|
|
1484
1499
|
|
1485
1500
|
begin
|
1486
|
-
#Get only a specific student's information.
|
1487
1501
|
result = api_instance.get_student(id)
|
1488
1502
|
p result
|
1489
1503
|
rescue Clever::ApiError => e
|
@@ -1515,7 +1529,7 @@ Name | Type | Description | Notes
|
|
1515
1529
|
# **get_student_for_contact**
|
1516
1530
|
> StudentResponse get_student_for_contact(id)
|
1517
1531
|
|
1518
|
-
|
1532
|
+
|
1519
1533
|
|
1520
1534
|
Returns the student for a student contact
|
1521
1535
|
|
@@ -1535,7 +1549,6 @@ id = "id_example" # String |
|
|
1535
1549
|
|
1536
1550
|
|
1537
1551
|
begin
|
1538
|
-
#Retrieves the student for a contact.
|
1539
1552
|
result = api_instance.get_student_for_contact(id)
|
1540
1553
|
p result
|
1541
1554
|
rescue Clever::ApiError => e
|
@@ -1567,7 +1580,7 @@ Name | Type | Description | Notes
|
|
1567
1580
|
# **get_students**
|
1568
1581
|
> StudentsResponse get_students(opts)
|
1569
1582
|
|
1570
|
-
|
1583
|
+
|
1571
1584
|
|
1572
1585
|
Returns a list of students
|
1573
1586
|
|
@@ -1590,7 +1603,6 @@ opts = {
|
|
1590
1603
|
}
|
1591
1604
|
|
1592
1605
|
begin
|
1593
|
-
#Gets a list of students you have access to.
|
1594
1606
|
result = api_instance.get_students(opts)
|
1595
1607
|
p result
|
1596
1608
|
rescue Clever::ApiError => e
|
@@ -1624,7 +1636,7 @@ Name | Type | Description | Notes
|
|
1624
1636
|
# **get_students_for_school**
|
1625
1637
|
> StudentsResponse get_students_for_school(id, opts)
|
1626
1638
|
|
1627
|
-
|
1639
|
+
|
1628
1640
|
|
1629
1641
|
Returns the students for a school
|
1630
1642
|
|
@@ -1649,7 +1661,6 @@ opts = {
|
|
1649
1661
|
}
|
1650
1662
|
|
1651
1663
|
begin
|
1652
|
-
#Retrieves a list of all students for a specific school.
|
1653
1664
|
result = api_instance.get_students_for_school(id, opts)
|
1654
1665
|
p result
|
1655
1666
|
rescue Clever::ApiError => e
|
@@ -1684,7 +1695,7 @@ Name | Type | Description | Notes
|
|
1684
1695
|
# **get_students_for_section**
|
1685
1696
|
> StudentsResponse get_students_for_section(id, opts)
|
1686
1697
|
|
1687
|
-
|
1698
|
+
|
1688
1699
|
|
1689
1700
|
Returns the students for a section
|
1690
1701
|
|
@@ -1709,7 +1720,6 @@ opts = {
|
|
1709
1720
|
}
|
1710
1721
|
|
1711
1722
|
begin
|
1712
|
-
#Retrieves a list of all the section's students.
|
1713
1723
|
result = api_instance.get_students_for_section(id, opts)
|
1714
1724
|
p result
|
1715
1725
|
rescue Clever::ApiError => e
|
@@ -1744,7 +1754,7 @@ Name | Type | Description | Notes
|
|
1744
1754
|
# **get_students_for_teacher**
|
1745
1755
|
> StudentsResponse get_students_for_teacher(id, opts)
|
1746
1756
|
|
1747
|
-
|
1757
|
+
|
1748
1758
|
|
1749
1759
|
Returns the students for a teacher
|
1750
1760
|
|
@@ -1769,7 +1779,6 @@ opts = {
|
|
1769
1779
|
}
|
1770
1780
|
|
1771
1781
|
begin
|
1772
|
-
#Retrieves all students that a teacher has in their sections.
|
1773
1782
|
result = api_instance.get_students_for_teacher(id, opts)
|
1774
1783
|
p result
|
1775
1784
|
rescue Clever::ApiError => e
|
@@ -1804,7 +1813,7 @@ Name | Type | Description | Notes
|
|
1804
1813
|
# **get_teacher**
|
1805
1814
|
> TeacherResponse get_teacher(id)
|
1806
1815
|
|
1807
|
-
|
1816
|
+
|
1808
1817
|
|
1809
1818
|
Returns a specific teacher
|
1810
1819
|
|
@@ -1824,7 +1833,6 @@ id = "id_example" # String |
|
|
1824
1833
|
|
1825
1834
|
|
1826
1835
|
begin
|
1827
|
-
#Get only a specific teacher's information.
|
1828
1836
|
result = api_instance.get_teacher(id)
|
1829
1837
|
p result
|
1830
1838
|
rescue Clever::ApiError => e
|
@@ -1856,7 +1864,7 @@ Name | Type | Description | Notes
|
|
1856
1864
|
# **get_teacher_for_section**
|
1857
1865
|
> TeacherResponse get_teacher_for_section(id)
|
1858
1866
|
|
1859
|
-
|
1867
|
+
|
1860
1868
|
|
1861
1869
|
Returns the primary teacher for a section
|
1862
1870
|
|
@@ -1876,7 +1884,6 @@ id = "id_example" # String |
|
|
1876
1884
|
|
1877
1885
|
|
1878
1886
|
begin
|
1879
|
-
#Retrieves information about the primary teacher of a section.
|
1880
1887
|
result = api_instance.get_teacher_for_section(id)
|
1881
1888
|
p result
|
1882
1889
|
rescue Clever::ApiError => e
|
@@ -1908,7 +1915,7 @@ Name | Type | Description | Notes
|
|
1908
1915
|
# **get_teachers**
|
1909
1916
|
> TeachersResponse get_teachers(opts)
|
1910
1917
|
|
1911
|
-
|
1918
|
+
|
1912
1919
|
|
1913
1920
|
Returns a list of teachers
|
1914
1921
|
|
@@ -1931,7 +1938,6 @@ opts = {
|
|
1931
1938
|
}
|
1932
1939
|
|
1933
1940
|
begin
|
1934
|
-
#Gets a list of teachers you have access to.
|
1935
1941
|
result = api_instance.get_teachers(opts)
|
1936
1942
|
p result
|
1937
1943
|
rescue Clever::ApiError => e
|
@@ -1965,7 +1971,7 @@ Name | Type | Description | Notes
|
|
1965
1971
|
# **get_teachers_for_school**
|
1966
1972
|
> TeachersResponse get_teachers_for_school(id, opts)
|
1967
1973
|
|
1968
|
-
|
1974
|
+
|
1969
1975
|
|
1970
1976
|
Returns the teachers for a school
|
1971
1977
|
|
@@ -1990,7 +1996,6 @@ opts = {
|
|
1990
1996
|
}
|
1991
1997
|
|
1992
1998
|
begin
|
1993
|
-
#Retrieves a list of all teachers for a specific school.
|
1994
1999
|
result = api_instance.get_teachers_for_school(id, opts)
|
1995
2000
|
p result
|
1996
2001
|
rescue Clever::ApiError => e
|
@@ -2025,7 +2030,7 @@ Name | Type | Description | Notes
|
|
2025
2030
|
# **get_teachers_for_section**
|
2026
2031
|
> TeachersResponse get_teachers_for_section(id, opts)
|
2027
2032
|
|
2028
|
-
|
2033
|
+
|
2029
2034
|
|
2030
2035
|
Returns the teachers for a section
|
2031
2036
|
|
@@ -2050,7 +2055,6 @@ opts = {
|
|
2050
2055
|
}
|
2051
2056
|
|
2052
2057
|
begin
|
2053
|
-
#Retrieves a list of all the section's teachers.
|
2054
2058
|
result = api_instance.get_teachers_for_section(id, opts)
|
2055
2059
|
p result
|
2056
2060
|
rescue Clever::ApiError => e
|
@@ -2085,7 +2089,7 @@ Name | Type | Description | Notes
|
|
2085
2089
|
# **get_teachers_for_student**
|
2086
2090
|
> TeachersResponse get_teachers_for_student(id, opts)
|
2087
2091
|
|
2088
|
-
|
2092
|
+
|
2089
2093
|
|
2090
2094
|
Returns the teachers for a student
|
2091
2095
|
|
@@ -2110,7 +2114,6 @@ opts = {
|
|
2110
2114
|
}
|
2111
2115
|
|
2112
2116
|
begin
|
2113
|
-
#Retrieves all teachers for a student.
|
2114
2117
|
result = api_instance.get_teachers_for_student(id, opts)
|
2115
2118
|
p result
|
2116
2119
|
rescue Clever::ApiError => e
|