strongmind-agilix-buzz-client 0.8.3
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 +7 -0
- data/.coveralls.yml +1 -0
- data/.env.sample +5 -0
- data/.github/workflows/dependabot-auto-merge.yml +0 -0
- data/.github/workflows/publish-gem.yml +51 -0
- data/.github/workflows/velocityCheckin.yml +45 -0
- data/.gitignore +25 -0
- data/.idea/.gitignore +8 -0
- data/.idea/agilix-buzz-client.iml +61 -0
- data/.idea/misc.xml +4 -0
- data/.idea/modules.xml +8 -0
- data/.idea/vcs.xml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +955 -0
- data/Rakefile +10 -0
- data/agilix.gemspec +40 -0
- data/bin/console +16 -0
- data/bin/setup +8 -0
- data/lib/agilix/buzz/api.rb +175 -0
- data/lib/agilix/buzz/commands/authentication.rb +153 -0
- data/lib/agilix/buzz/commands/course.rb +91 -0
- data/lib/agilix/buzz/commands/domain.rb +85 -0
- data/lib/agilix/buzz/commands/enrollment.rb +140 -0
- data/lib/agilix/buzz/commands/general.rb +70 -0
- data/lib/agilix/buzz/commands/library.rb +43 -0
- data/lib/agilix/buzz/commands/report.rb +37 -0
- data/lib/agilix/buzz/commands/resource.rb +124 -0
- data/lib/agilix/buzz/commands/right.rb +234 -0
- data/lib/agilix/buzz/commands/user.rb +85 -0
- data/lib/agilix/version.rb +3 -0
- data/lib/agilix.rb +31 -0
- data/stats.html +1 -0
- metadata +205 -0
data/README.md
ADDED
@@ -0,0 +1,955 @@
|
|
1
|
+
[](https://badge.fury.io/rb/agilix)
|
2
|
+
[](https://travis-ci.com/beneggett/agilix)
|
3
|
+
[](https://coveralls.io/github/beneggett/agilix?branch=master)
|
4
|
+
# Agilix Buzz
|
5
|
+
|
6
|
+
Fully Implements the Agilix Buzz API in Ruby
|
7
|
+
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
gem 'agilix'
|
15
|
+
```
|
16
|
+
|
17
|
+
And then execute:
|
18
|
+
|
19
|
+
$ bundle
|
20
|
+
|
21
|
+
Or install it yourself as:
|
22
|
+
|
23
|
+
$ gem install agilix
|
24
|
+
|
25
|
+
Be sure to define your Agilix Buzz credentials by setting up environment variables in your application appropriately. Refer to the .env.sample file for details.
|
26
|
+
```
|
27
|
+
AGILIX_BUZZ_USERNAME = 'my-username'
|
28
|
+
AGILIX_BUZZ_PASSWORD = 'my-password'
|
29
|
+
```
|
30
|
+
|
31
|
+
Optionally, if your Buzz instance runs on your own url, you can define it as well:
|
32
|
+
|
33
|
+
```
|
34
|
+
AGILIX_BUZZ_URL = 'https://api.mycustomdomain.com'
|
35
|
+
```
|
36
|
+
|
37
|
+
## Usage
|
38
|
+
|
39
|
+
There are many primary APIs that are wrapped. Below you will see basic examples of how to use them. For more information about what optional query parameters are available, please consult the [Agilix Buzz API Docs](https://api.agilixbuzz.com/)
|
40
|
+
|
41
|
+
### Auth
|
42
|
+
|
43
|
+
You need to authenticate to use the api. Set the credentials in Environment variables as seen above. If you've done that, you can set and refernce the api object by:
|
44
|
+
```
|
45
|
+
api = Agilix::Buzz::Api.new
|
46
|
+
```
|
47
|
+
|
48
|
+
Otherwise, you can pass `:username`, `:password`, and `:domain` into the initializer
|
49
|
+
```
|
50
|
+
api = Agilix::Buzz::Api.new username: 'my-username', password: 'my-password', domain: 'my-domain'
|
51
|
+
```
|
52
|
+
The authentication API gives you back a token that can be used within a 15 minute window. This library will manage the need to fetch a new token or `extend_session` by setting the token & token expiration in the initialized api object.
|
53
|
+
|
54
|
+
### Passing arguments
|
55
|
+
|
56
|
+
All APIs have defined required arguments and optional arguments, and an argument cleaner will prevent the calls from being made if conditions are not met. Additionally it will strip out any unsupported api params that are not defined in the required or optional fields.
|
57
|
+
|
58
|
+
Below are instructions for basic invocation of the api methods. For additional information about each API method, please consult the Agilix documentation, linked in each method's name.
|
59
|
+
|
60
|
+
### Domains
|
61
|
+
|
62
|
+
#### [CreateDomains](https://api.agilixbuzz.com/docs/#!/Command/CreateDomains)
|
63
|
+
```
|
64
|
+
api.create_domains [{name: "BuzzTest1", userspace: 'buzz-test-fc-1', parentid: '57025'}]
|
65
|
+
```
|
66
|
+
|
67
|
+
#### [DeleteDomain](https://api.agilixbuzz.com/docs/#!/Command/DeleteDomain)
|
68
|
+
```
|
69
|
+
api.delete_domain domainid: '57027'
|
70
|
+
```
|
71
|
+
|
72
|
+
#### [GetDomain2](https://api.agilixbuzz.com/docs/#!/Command/GetDomain2)
|
73
|
+
This is aliased to `get_domain`
|
74
|
+
```
|
75
|
+
api.get_domain domainid: '57025'
|
76
|
+
```
|
77
|
+
|
78
|
+
#### [GetDomainContent](https://api.agilixbuzz.com/docs/#!/Command/GetDomainContent)
|
79
|
+
```
|
80
|
+
api.get_domain_content domainid: '57025'
|
81
|
+
```
|
82
|
+
|
83
|
+
#### [GetDomainEnrollmentMetrics](https://api.agilixbuzz.com/docs/#!/Command/GetDomainEnrollmentMetrics)
|
84
|
+
```
|
85
|
+
api.get_domain_enrollment_metrics domainid: '57025'
|
86
|
+
```
|
87
|
+
|
88
|
+
#### [GetDomainParentList](https://api.agilixbuzz.com/docs/#!/Command/GetDomainParentList)
|
89
|
+
```
|
90
|
+
api.get_domain_parent_list domainid: '57025'
|
91
|
+
```
|
92
|
+
|
93
|
+
#### [GetDomainSettings](https://api.agilixbuzz.com/docs/#!/Command/GetDomainSettings)
|
94
|
+
```
|
95
|
+
api.get_domain_settings domainid: '57025', path: "AgilixBuzzSettings.xml"
|
96
|
+
```
|
97
|
+
|
98
|
+
#### [GetDomainStats](https://api.agilixbuzz.com/docs/#!/Command/GetDomainStats)
|
99
|
+
```
|
100
|
+
api.get_domain_stats domainid: '57025', options: "users|courses"
|
101
|
+
```
|
102
|
+
|
103
|
+
#### [ListDomains](https://api.agilixbuzz.com/docs/#!/Command/ListDomains)
|
104
|
+
```
|
105
|
+
api.list_domains domainid: '57025'
|
106
|
+
```
|
107
|
+
|
108
|
+
#### [RestoreDomain](https://api.agilixbuzz.com/docs/#!/Command/RestoreDomain)
|
109
|
+
```
|
110
|
+
api.restore_domain domainid: '57027'
|
111
|
+
```
|
112
|
+
|
113
|
+
#### [UpdateDomains](https://api.agilixbuzz.com/docs/#!/Command/UpdateDomains)
|
114
|
+
```
|
115
|
+
api.update_domains [{ domainid: "57027", name: "BuzzTestUpdated1", userspace: 'buzz-test-fc-1', parentid: '57025'}]
|
116
|
+
```
|
117
|
+
|
118
|
+
### Reports
|
119
|
+
|
120
|
+
`get_runnable_report_list` and `run_report` are probably the only ones you would use.
|
121
|
+
|
122
|
+
#### [GetReportInfo](https://api.agilixbuzz.com/docs/#!/Command/GetReportInfo)
|
123
|
+
```
|
124
|
+
api.get_report_info reportid: 127
|
125
|
+
```
|
126
|
+
|
127
|
+
#### [GetReportList](https://api.agilixbuzz.com/docs/#!/Command/GetReportList)
|
128
|
+
```
|
129
|
+
api.get_report_list domainid: 1
|
130
|
+
```
|
131
|
+
|
132
|
+
#### [GetRunnableReportList](https://api.agilixbuzz.com/docs/#!/Command/GetRunnableReportList)
|
133
|
+
```
|
134
|
+
api.get_runnable_report_list domainid: 57025
|
135
|
+
```
|
136
|
+
|
137
|
+
#### [RunReport](https://api.agilixbuzz.com/docs/#!/Command/RunReport)
|
138
|
+
```
|
139
|
+
api.run_report reportid: 127, entityid: 57025, format: 'json'
|
140
|
+
```
|
141
|
+
|
142
|
+
## Users
|
143
|
+
|
144
|
+
#### [CreateUsers2](https://api.agilixbuzz.com/docs/#!/Command/CreateUsers2)
|
145
|
+
This is aliased to `create_users`
|
146
|
+
```
|
147
|
+
api.create_users( [{
|
148
|
+
domainid: '57025',
|
149
|
+
username: "BuzzUserTest1",
|
150
|
+
email: 'buzzusertest1@agilix.com',
|
151
|
+
password: 'testpassword1234',
|
152
|
+
firstname: 'Buzz',
|
153
|
+
lastname: "Man",
|
154
|
+
passwordquestion: "Who's your best friend?",
|
155
|
+
passwordanswer: "Me"
|
156
|
+
}] )
|
157
|
+
```
|
158
|
+
|
159
|
+
#### [DeleteUsers](https://api.agilixbuzz.com/docs/#!/Command/DeleteUsers)
|
160
|
+
```
|
161
|
+
api.delete_users [userid: '57181']
|
162
|
+
```
|
163
|
+
|
164
|
+
#### [GetActiveUserCount](https://api.agilixbuzz.com/docs/#!/Command/GetActiveUserCount)
|
165
|
+
```
|
166
|
+
api.get_active_user_count domainid: '57025'
|
167
|
+
api.get_active_user_count domainid: '5', includedescendantdomains: true, bymonth:true, startdate: '2018-01-01', enddate: '2019-03-01'
|
168
|
+
```
|
169
|
+
|
170
|
+
#### [GetDomainActivity](https://api.agilixbuzz.com/docs/#!/Command/GetDomainActivity)
|
171
|
+
```
|
172
|
+
api.get_domain_activity domainid: '57025'
|
173
|
+
```
|
174
|
+
|
175
|
+
#### [GetProfilePicture](https://api.agilixbuzz.com/docs/#!/Command/GetProfilePicture)
|
176
|
+
Returns base 64 encoded picture
|
177
|
+
```
|
178
|
+
api.get_profile_picture entityid: 57026
|
179
|
+
```
|
180
|
+
The api will return 404 not found if they don't have one, unless you supply it with a default profile pic, then it will return that
|
181
|
+
```
|
182
|
+
api.get_profile_picture entityid: 57025, default: "https://www.gravatar.com/avatar/00000000000000000000000000000000?d=mm"
|
183
|
+
```
|
184
|
+
|
185
|
+
#### [GetUser2](https://api.agilixbuzz.com/docs/#!/Command/GetUser2)
|
186
|
+
This is aliased to `get_user`
|
187
|
+
```
|
188
|
+
api.get_user userid: 57026
|
189
|
+
```
|
190
|
+
|
191
|
+
#### [GetUserActivity](https://api.agilixbuzz.com/docs/#!/Command/GetUserActivity)
|
192
|
+
```
|
193
|
+
api.get_user_activity userid: 57026
|
194
|
+
```
|
195
|
+
|
196
|
+
#### [GetUserActivityStream](https://api.agilixbuzz.com/docs/#!/Command/GetUserActivityStream)
|
197
|
+
```
|
198
|
+
api.get_user_activity_stream userid: 57026
|
199
|
+
```
|
200
|
+
|
201
|
+
#### [ListUsers](https://api.agilixbuzz.com/docs/#!/Command/ListUsers)
|
202
|
+
```
|
203
|
+
api.list_users domainid: 57025
|
204
|
+
```
|
205
|
+
|
206
|
+
#### [RestoreUser](https://api.agilixbuzz.com/docs/#!/Command/RestoreUser)
|
207
|
+
```
|
208
|
+
api.restore_user userid: 57026
|
209
|
+
```
|
210
|
+
|
211
|
+
#### [UpdateUsers](https://api.agilixbuzz.com/docs/#!/Command/UpdateUsers)
|
212
|
+
```
|
213
|
+
api.update_users [{ userid: '57026', username: "BuzzUserTestUpdated1", email: 'buzzusertest1@agilix.com',firstname: 'Buzz', lastname: "ManUpdated"}]
|
214
|
+
```
|
215
|
+
|
216
|
+
---
|
217
|
+
|
218
|
+
# Second Priority
|
219
|
+
|
220
|
+
## Authentication
|
221
|
+
|
222
|
+
#### [Login2](https://api.agilixbuzz.com/docs/#!/Command/Login2)
|
223
|
+
This is handled automatically by instantiation of a base Agilix::Buzz::Api instance. It wouldn't need to be called manually unless using for other users or making calls on their behalf
|
224
|
+
```
|
225
|
+
api.login username: 'my-username', password: 'my-password', domain: 'my-domain'
|
226
|
+
```
|
227
|
+
|
228
|
+
#### [Logout](https://api.agilixbuzz.com/docs/#!/Command/Logout)
|
229
|
+
Clears your login session
|
230
|
+
```
|
231
|
+
api.logout
|
232
|
+
```
|
233
|
+
|
234
|
+
#### [ExtendSession](https://api.agilixbuzz.com/docs/#!/Command/ExtendSession)
|
235
|
+
This is handled automatically by instantiation of a base Agilix::Buzz::Api instance and on subsequent calls to the api through the check_authentication method
|
236
|
+
```
|
237
|
+
api.extend_session
|
238
|
+
```
|
239
|
+
|
240
|
+
#### [ForcePasswordChange](https://api.agilixbuzz.com/docs/#!/Command/ForcePasswordChange)
|
241
|
+
```
|
242
|
+
api.force_password_change userid: 57181
|
243
|
+
```
|
244
|
+
|
245
|
+
#### [GetPasswordLoginAttemptHistory](https://api.agilixbuzz.com/docs/#!/Command/GetPasswordLoginAttemptHistory)
|
246
|
+
```
|
247
|
+
api.get_password_login_attempt_history userid: 57181
|
248
|
+
api.get_password_login_attempt_history userid: 57181, earliestrecordtoreturn: '2018-01-01'
|
249
|
+
```
|
250
|
+
|
251
|
+
#### [GetPasswordPolicy](https://api.agilixbuzz.com/docs/#!/Command/GetPasswordPolicy)
|
252
|
+
For current domain
|
253
|
+
```
|
254
|
+
api.get_password_policy
|
255
|
+
```
|
256
|
+
for a specific domain
|
257
|
+
```
|
258
|
+
api.get_password_policy domainid: 57031
|
259
|
+
```
|
260
|
+
|
261
|
+
#### [GetPasswordQuestion](https://api.agilixbuzz.com/docs/#!/Command/GetPasswordQuestion)
|
262
|
+
```
|
263
|
+
api.get_password_question username: "auto-tests/BuzzUserUp1"
|
264
|
+
```
|
265
|
+
|
266
|
+
#### [UpdatePasswordQuestionAnswer](https://api.agilixbuzz.com/docs/#!/Command/UpdatePasswordQuestionAnswer)
|
267
|
+
ISSUE: This works with a GET call
|
268
|
+
```
|
269
|
+
api.update_password_question_answer userid: 57181, passwordquestion: "Where is your favorite vacation place?", passwordanswer: "Hawaii"
|
270
|
+
|
271
|
+
```
|
272
|
+
|
273
|
+
#### [Proxy](https://api.agilixbuzz.com/docs/#!/Command/Proxy)
|
274
|
+
```
|
275
|
+
api.proxy userid: 57181
|
276
|
+
```
|
277
|
+
In addition to these, we've created a proxy api method that will setup an api client for the proxied connection:
|
278
|
+
|
279
|
+
#### Proxy Api
|
280
|
+
```
|
281
|
+
proxy_api = api.proxy_api userid: 57181
|
282
|
+
```
|
283
|
+
|
284
|
+
This will allow you to make requests as the proxied user, like you would the main api user. It's required to demonstrate how unproxy works below
|
285
|
+
|
286
|
+
#### [Unproxy](https://api.agilixbuzz.com/docs/#!/Command/Unproxy)
|
287
|
+
First setup a proxy_api
|
288
|
+
```
|
289
|
+
proxy_api = api.proxy_api userid: 57181
|
290
|
+
```
|
291
|
+
Then you can unproxy out of it to logout as the proxied user
|
292
|
+
```
|
293
|
+
proxy_api.unproxy userid: 57181
|
294
|
+
```
|
295
|
+
|
296
|
+
#### [ResetLockout](https://api.agilixbuzz.com/docs/#!/Command/ResetLockout)
|
297
|
+
```
|
298
|
+
api.reset_lockout userid: 57181
|
299
|
+
```
|
300
|
+
|
301
|
+
#### [ResetPassword](https://api.agilixbuzz.com/docs/#!/Command/ResetPassword)
|
302
|
+
```
|
303
|
+
api.reset_password username:'auto-tests/BuzzUserUp1'
|
304
|
+
```
|
305
|
+
|
306
|
+
#### [UpdatePassword](https://api.agilixbuzz.com/docs/#!/Command/UpdatePassword)
|
307
|
+
```
|
308
|
+
api.update_password userid: 57181, password: "IChanged123"
|
309
|
+
```
|
310
|
+
|
311
|
+
#### [PutKey](https://api.agilixbuzz.com/docs/#!/Command/PutKey)
|
312
|
+
ISSUE: This should be a POST method as it's storing data
|
313
|
+
```
|
314
|
+
api.put_key entityid: 57031, name: 'secret_key_1', value: "Super Secret"
|
315
|
+
```
|
316
|
+
|
317
|
+
#### [GetKey](https://api.agilixbuzz.com/docs/#!/Command/GetKey)
|
318
|
+
```
|
319
|
+
api.get_key entityid: 57031, name: 'secret_key_1'
|
320
|
+
```
|
321
|
+
|
322
|
+
#### [ComputeHMAC](https://api.agilixbuzz.com/docs/#!/Command/ComputeHMAC)
|
323
|
+
This requires a key to exist with the given keyname, see `put_key`. **not sure what its used for yet**
|
324
|
+
```
|
325
|
+
api.compute_hmac domainid: 57025, keyname: "secret_key_1", message:"my-secret-1"
|
326
|
+
```
|
327
|
+
|
328
|
+
## Courses
|
329
|
+
|
330
|
+
#### [CopyCourses](https://api.agilixbuzz.com/docs/#!/Command/CopyCourses)
|
331
|
+
```
|
332
|
+
api.copy_courses [{courseid: 60982, domainid: 57025}]
|
333
|
+
```
|
334
|
+
|
335
|
+
#### [CreateCourses](https://api.agilixbuzz.com/docs/#!/Command/CreateCourses)
|
336
|
+
```
|
337
|
+
api.create_courses title: "Starter Course", domainid: 57025
|
338
|
+
```
|
339
|
+
|
340
|
+
#### [CreateDemoCourse](https://api.agilixbuzz.com/docs/#!/Command/CreateDemoCourse)
|
341
|
+
ISSUE: documentation on request format is inconsistent, not sure if it is bulk
|
342
|
+
```
|
343
|
+
api.create_demo_course courseid: 60982, domainid: 57025, title: "Demo Course",
|
344
|
+
```
|
345
|
+
|
346
|
+
#### [DeactivateCourse](https://api.agilixbuzz.com/docs/#!/Command/DeactivateCourse)
|
347
|
+
ISSUE: get request should be delete, put, patch
|
348
|
+
```
|
349
|
+
api.deactivate_course
|
350
|
+
```
|
351
|
+
|
352
|
+
#### [DeleteCourses](https://api.agilixbuzz.com/docs/#!/Command/DeleteCourses)
|
353
|
+
ISSUE: Why so different than deactivate course
|
354
|
+
```
|
355
|
+
api.delete_courses [{courseid: 60994}]
|
356
|
+
```
|
357
|
+
|
358
|
+
#### [GetCourse2](https://api.agilixbuzz.com/docs/#!/Command/GetCourse2)
|
359
|
+
```
|
360
|
+
api.get_course2 courseid: 60994
|
361
|
+
```
|
362
|
+
|
363
|
+
#### [GetCourseHistory](https://api.agilixbuzz.com/docs/#!/Command/GetCourseHistory)
|
364
|
+
```
|
365
|
+
api.get_course_history courseid: 60994
|
366
|
+
```
|
367
|
+
|
368
|
+
#### [ListCourses](https://api.agilixbuzz.com/docs/#!/Command/ListCourses)
|
369
|
+
```
|
370
|
+
api.list_courses domainid: 5
|
371
|
+
```
|
372
|
+
|
373
|
+
#### [MergeCourses](https://api.agilixbuzz.com/docs/#!/Command/MergeCourses)
|
374
|
+
```
|
375
|
+
api.merge_courses courseid: 60994
|
376
|
+
```
|
377
|
+
|
378
|
+
#### [RestoreCourse](https://api.agilixbuzz.com/docs/#!/Command/RestoreCourse)
|
379
|
+
```
|
380
|
+
api.restore_course courseid: 60994
|
381
|
+
```
|
382
|
+
|
383
|
+
#### [UpdateCourses](https://api.agilixbuzz.com/docs/#!/Command/UpdateCourses)
|
384
|
+
```
|
385
|
+
api.update_courses [{courseid: 60994, title: "Updated Course"}]
|
386
|
+
```
|
387
|
+
|
388
|
+
|
389
|
+
## Enrollments
|
390
|
+
|
391
|
+
#### [CreateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/CreateEnrollments)
|
392
|
+
ISSUE: API format is very inconsistent on this one, requires both query string modification & body modification
|
393
|
+
```
|
394
|
+
api.create_enrollments [{userid: 57026, entityid: 57025}]
|
395
|
+
```
|
396
|
+
|
397
|
+
#### [DeleteEnrollments](https://api.agilixbuzz.com/docs/#!/Command/DeleteEnrollments)
|
398
|
+
ISSUE: Inconsistent from other delete apis. many are singular, not plural
|
399
|
+
```
|
400
|
+
api.delete_enrollments [ { enrollmentid: 60997 }]
|
401
|
+
```
|
402
|
+
|
403
|
+
#### [GetEnrollment3](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollment3)
|
404
|
+
This is aliased to `get_enrollment`
|
405
|
+
```
|
406
|
+
api.get_enrollment enrollmentid: 60997
|
407
|
+
```
|
408
|
+
|
409
|
+
#### [GetEnrollmentActivity](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentActivity)
|
410
|
+
```
|
411
|
+
api.get_enrollment_activity enrollmentid: 60997
|
412
|
+
```
|
413
|
+
|
414
|
+
#### [GetEnrollmentGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGradebook2)
|
415
|
+
```
|
416
|
+
api.get_enrollment_gradebook enrollmentid: 60997
|
417
|
+
```
|
418
|
+
|
419
|
+
#### [GetEnrollmentGroupList](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGroupList)
|
420
|
+
```
|
421
|
+
api.get_enrollment_group_list enrollmentid: 60997
|
422
|
+
```
|
423
|
+
|
424
|
+
#### [GetEnrollmentMetricsReport](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentMetricsReport)
|
425
|
+
This is available in two types:
|
426
|
+
Student Report
|
427
|
+
```
|
428
|
+
api.get_enrollment_metrics_report entityid: 50725, report: "Student"
|
429
|
+
```
|
430
|
+
Enrollment Report
|
431
|
+
```
|
432
|
+
api.get_enrollment_metrics_report entityid: 50725, report: "Enrollment"
|
433
|
+
```
|
434
|
+
|
435
|
+
#### [ListEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollments)
|
436
|
+
```
|
437
|
+
api.list_enrollments domainid: 50725
|
438
|
+
```
|
439
|
+
|
440
|
+
#### [ListEnrollmentsByTeacher](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollmentsByTeacher)
|
441
|
+
```
|
442
|
+
api.list_enrollments_by_teacher teacheruserid: 50726
|
443
|
+
|
444
|
+
# If you don't pass in a teacher user id, it will default to the logged in API user
|
445
|
+
|
446
|
+
api.list_enrollments_by_teacher
|
447
|
+
```
|
448
|
+
|
449
|
+
#### [ListEntityEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEntityEnrollments)
|
450
|
+
```
|
451
|
+
api.list_entity_enrollments entityid: 60982
|
452
|
+
```
|
453
|
+
|
454
|
+
#### [ListUserEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListUserEnrollments)
|
455
|
+
```
|
456
|
+
api.list_user_enrollments userid: 57181
|
457
|
+
```
|
458
|
+
|
459
|
+
#### [PutSelfAssessment](https://api.agilixbuzz.com/docs/#!/Command/PutSelfAssessment)
|
460
|
+
# ISSUE: this should be a post, not a get
|
461
|
+
```
|
462
|
+
api.put_self_assessment enrollmentid: 60997, understanding: 200, effort: 220, interest: 100
|
463
|
+
```
|
464
|
+
|
465
|
+
#### [RestoreEnrollment](https://api.agilixbuzz.com/docs/#!/Command/RestoreEnrollment)
|
466
|
+
```
|
467
|
+
api.restore_enrollment enrollmentid: 60997
|
468
|
+
```
|
469
|
+
|
470
|
+
#### [UpdateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/UpdateEnrollments)
|
471
|
+
```
|
472
|
+
api.update_enrollments [{enrollmentid: 60997, status: 7}]
|
473
|
+
```
|
474
|
+
|
475
|
+
## General
|
476
|
+
|
477
|
+
#### [Echo](https://api.agilixbuzz.com/docs/#!/Command/Echo)
|
478
|
+
```
|
479
|
+
api.echo test: 'param'
|
480
|
+
```
|
481
|
+
|
482
|
+
#### [GetCommandList](https://api.agilixbuzz.com/docs/#!/Command/GetCommandList)
|
483
|
+
```
|
484
|
+
api.get_command_list
|
485
|
+
```
|
486
|
+
|
487
|
+
#### [GetEntityType](https://api.agilixbuzz.com/docs/#!/Command/GetEntityType)
|
488
|
+
ISSUE: nothing saying this is an authenticated call, when others are non-authenticated
|
489
|
+
```
|
490
|
+
api.get_entity_type entityid: 57025
|
491
|
+
```
|
492
|
+
|
493
|
+
#### [GetStatus](https://api.agilixbuzz.com/docs/#!/Command/GetStatus)
|
494
|
+
ISSUE: docs in getting started reference a `level` param, actual docs suggest using rating
|
495
|
+
```
|
496
|
+
api.get_status rating: 4, html: true, sms: true
|
497
|
+
|
498
|
+
# you can also call this one non-authenticated
|
499
|
+
api.get_basic_status
|
500
|
+
```
|
501
|
+
|
502
|
+
#### [GetUploadLimits](https://api.agilixbuzz.com/docs/#!/Command/GetUploadLimits)
|
503
|
+
ISSUE: Docs have cmd spelled wrong, this API doesn't seem to work at all AccessDenied. It did say experimental
|
504
|
+
```
|
505
|
+
api.get_upload_limits
|
506
|
+
api.get_upload_limits domainid: 57025
|
507
|
+
```
|
508
|
+
|
509
|
+
#### [SendMail](https://api.agilixbuzz.com/docs/#!/Command/SendMail)
|
510
|
+
This is one of the more confusing APIs, it allows you to send emails to people in the same enrollment grouping as the person wanting to send the email (`enrollmentid`).
|
511
|
+
```
|
512
|
+
api.send_mail subject: "Test email", body: "Did you get this?", enrollmentid: 60997, enrollment_ids: ["all"]
|
513
|
+
```
|
514
|
+
|
515
|
+
## Resources
|
516
|
+
|
517
|
+
|
518
|
+
#### [CopyResources](https://api.agilixbuzz.com/docs/#!/Command/CopyResources)
|
519
|
+
|
520
|
+
```
|
521
|
+
api.copy_resources [ {sourceentityid: 57025, destinationentityid: 57031, sourcepath: "banner.css" }]
|
522
|
+
```
|
523
|
+
|
524
|
+
#### [DeleteResources](https://api.agilixbuzz.com/docs/#!/Command/DeleteResources)
|
525
|
+
|
526
|
+
```
|
527
|
+
api.delete_resources [{entityid: 57031, path: 'banner.css'}]
|
528
|
+
```
|
529
|
+
|
530
|
+
#### [GetEntityResourceId](https://api.agilixbuzz.com/docs/#!/Command/GetEntityResourceId)
|
531
|
+
|
532
|
+
```
|
533
|
+
api.get_entity_resource_id entityid: 57025
|
534
|
+
```
|
535
|
+
|
536
|
+
#### [GetResource](https://api.agilixbuzz.com/docs/#!/Command/GetResource)
|
537
|
+
|
538
|
+
```
|
539
|
+
api.get_resource entityid: 57031, path: "banner.css"
|
540
|
+
```
|
541
|
+
|
542
|
+
#### [GetResourceInfo2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceInfo2)
|
543
|
+
|
544
|
+
ISSUE: This is a get request with a POST verb. The documentation only suggests getting a single resoure, so I'm not sure why it would be a bulk post syntax. it does seem to respond to multiple resources though,so we'll adapt
|
545
|
+
|
546
|
+
```
|
547
|
+
api.get_resource_info [{entityid: 57031, path: "banner.css"}]
|
548
|
+
```
|
549
|
+
|
550
|
+
#### [GetResourceList2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceList2)
|
551
|
+
|
552
|
+
```
|
553
|
+
api.get_resource_list entityid: 57025
|
554
|
+
```
|
555
|
+
|
556
|
+
#### [ListRestorableResources](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableResources)
|
557
|
+
|
558
|
+
```
|
559
|
+
api.list_restorable_resources entityid: 57025
|
560
|
+
```
|
561
|
+
|
562
|
+
#### [PutResource](https://api.agilixbuzz.com/docs/#!/Command/PutResource)
|
563
|
+
|
564
|
+
```
|
565
|
+
file_name = "my-file.pdf"
|
566
|
+
file = File.open file_name
|
567
|
+
api.put_resource file, {entityid: 57025, path: file_name}
|
568
|
+
```
|
569
|
+
|
570
|
+
#### [PutResourceFolders](https://api.agilixbuzz.com/docs/#!/Command/PutResourceFolders)
|
571
|
+
|
572
|
+
```
|
573
|
+
api.put_resource_folders [{entityid: 57031, path: 'test/folder-1'}]
|
574
|
+
```
|
575
|
+
|
576
|
+
#### [RestoreResources](https://api.agilixbuzz.com/docs/#!/Command/RestoreResources)
|
577
|
+
|
578
|
+
```
|
579
|
+
api.restore_resources [{entityid: 57031, path: 'banner.css'}]
|
580
|
+
```
|
581
|
+
|
582
|
+
|
583
|
+
## Rights
|
584
|
+
|
585
|
+
#### [CreateRole](https://api.agilixbuzz.com/docs/#!/Command/CreateRole)
|
586
|
+
ISSUE: Why is this create singular, not multiple?
|
587
|
+
```
|
588
|
+
api.create_role domainid: 57025, name: "Test Role", privileges: api.right_flags[:create_domain]
|
589
|
+
```
|
590
|
+
|
591
|
+
#### [DeleteRole](https://api.agilixbuzz.com/docs/#!/Command/DeleteRole)
|
592
|
+
```
|
593
|
+
api.delete_role roleid: 61316
|
594
|
+
```
|
595
|
+
|
596
|
+
#### [DeleteSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/DeleteSubscriptions)
|
597
|
+
ISSUE: Why is this create singular, not multiple?
|
598
|
+
```
|
599
|
+
api.delete_subscriptions subscriberid: 57181, entityid: 57025
|
600
|
+
```
|
601
|
+
|
602
|
+
#### [GetActorRights](https://api.agilixbuzz.com/docs/#!/Command/GetActorRights)
|
603
|
+
ISSUE: Why is this create singular, not multiple?
|
604
|
+
```
|
605
|
+
api.create_role domainid: 57025, name: "Test Role", privileges: api.right_flags[:create_domain]
|
606
|
+
```
|
607
|
+
|
608
|
+
#### [GetEffectiveRights](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveRights)
|
609
|
+
```
|
610
|
+
api.get_effective_rights entityid: 57025
|
611
|
+
```
|
612
|
+
|
613
|
+
#### [GetEffectiveSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveSubscriptionList)
|
614
|
+
```
|
615
|
+
api.get_effective_subscription_list
|
616
|
+
```
|
617
|
+
|
618
|
+
#### [GetEntityRights](https://api.agilixbuzz.com/docs/#!/Command/GetEntityRights)
|
619
|
+
```
|
620
|
+
api.get_entity_rights entityid: 57025
|
621
|
+
```
|
622
|
+
|
623
|
+
#### [GetEntitySubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEntitySubscriptionList)
|
624
|
+
```
|
625
|
+
api.get_entity_subscription_list entityid: 57025
|
626
|
+
```
|
627
|
+
|
628
|
+
#### [GetPersonas](https://api.agilixbuzz.com/docs/#!/Command/GetPersonas)
|
629
|
+
```
|
630
|
+
api.get_personas userid: 57026
|
631
|
+
```
|
632
|
+
|
633
|
+
#### [GetRights](https://api.agilixbuzz.com/docs/#!/Command/GetRights)
|
634
|
+
```
|
635
|
+
api.get_rights actorid: 57026, entityid: 57025
|
636
|
+
```
|
637
|
+
|
638
|
+
#### [GetRightsList](https://api.agilixbuzz.com/docs/#!/Command/GetRightsList)
|
639
|
+
```
|
640
|
+
api.get_rights_list domainid: 57025
|
641
|
+
```
|
642
|
+
|
643
|
+
#### [GetRole](https://api.agilixbuzz.com/docs/#!/Command/GetRole)
|
644
|
+
```
|
645
|
+
api.get_role roleid: 61316
|
646
|
+
```
|
647
|
+
|
648
|
+
#### [GetSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetSubscriptionList)
|
649
|
+
```
|
650
|
+
# Get for a domain
|
651
|
+
api.get_subscription_list subscriberid: 57025
|
652
|
+
# Get for a user
|
653
|
+
api.get_subscription_list subscriberid: 57026
|
654
|
+
```
|
655
|
+
|
656
|
+
#### [ListRoles](https://api.agilixbuzz.com/docs/#!/Command/ListRoles)
|
657
|
+
```
|
658
|
+
api.list_roles domainid: 57025
|
659
|
+
```
|
660
|
+
|
661
|
+
#### [RestoreRole](https://api.agilixbuzz.com/docs/#!/Command/RestoreRole)
|
662
|
+
```
|
663
|
+
api.restore_role roleid: 61316
|
664
|
+
```
|
665
|
+
|
666
|
+
#### [UpdateRights](https://api.agilixbuzz.com/docs/#!/Command/UpdateRights)
|
667
|
+
```
|
668
|
+
api.update_rights [ {actorid: 57026, entityid: 57025, roleid: 61316}]
|
669
|
+
```
|
670
|
+
|
671
|
+
#### [UpdateRole](https://api.agilixbuzz.com/docs/#!/Command/UpdateRole)
|
672
|
+
```
|
673
|
+
api.update_role roleid: 61316, name: "Test Role Updates", privileges: api.right_flags[:update_domain]
|
674
|
+
```
|
675
|
+
|
676
|
+
#### [UpdateSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/UpdateSubscriptions)
|
677
|
+
ISSUE: Why is this root node singular?
|
678
|
+
```
|
679
|
+
api.update_subscriptions subscriberid: 57181, entityid: 60982, startdate: "2019-03-15", enddate: "2019-03-15"
|
680
|
+
```
|
681
|
+
|
682
|
+
---
|
683
|
+
|
684
|
+
# Third Priority
|
685
|
+
|
686
|
+
## Assessments
|
687
|
+
|
688
|
+
- [ ] [DeleteQuestions](https://api.agilixbuzz.com/docs/#!/Command/DeleteQuestions)
|
689
|
+
- [ ] [GetAttempt](https://api.agilixbuzz.com/docs/#!/Command/GetAttempt)
|
690
|
+
- [ ] [GetAttemptReview](https://api.agilixbuzz.com/docs/#!/Command/GetAttemptReview)
|
691
|
+
- [ ] [GetExam](https://api.agilixbuzz.com/docs/#!/Command/GetExam)
|
692
|
+
- [ ] [GetNextQuestion](https://api.agilixbuzz.com/docs/#!/Command/GetNextQuestion)
|
693
|
+
- [ ] [GetQuestion](https://api.agilixbuzz.com/docs/#!/Command/GetQuestion)
|
694
|
+
- [ ] [GetQuestionScores](https://api.agilixbuzz.com/docs/#!/Command/GetQuestionScores)
|
695
|
+
- [ ] [GetQuestionStats](https://api.agilixbuzz.com/docs/#!/Command/GetQuestionStats)
|
696
|
+
- [ ] [GetSubmissionState](https://api.agilixbuzz.com/docs/#!/Command/GetSubmissionState)
|
697
|
+
- [ ] [ListQuestions](https://api.agilixbuzz.com/docs/#!/Command/ListQuestions)
|
698
|
+
- [ ] [ListRestorableQuestions](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableQuestions)
|
699
|
+
- [ ] [PrepareOfflineAttempt](https://api.agilixbuzz.com/docs/#!/Command/PrepareOfflineAttempt)
|
700
|
+
- [ ] [PutQuestions](https://api.agilixbuzz.com/docs/#!/Command/PutQuestions)
|
701
|
+
- [ ] [RestoreQuestions](https://api.agilixbuzz.com/docs/#!/Command/RestoreQuestions)
|
702
|
+
- [ ] [SaveAttemptAnswers](https://api.agilixbuzz.com/docs/#!/Command/SaveAttemptAnswers)
|
703
|
+
- [ ] [SubmitAttemptAnswers](https://api.agilixbuzz.com/docs/#!/Command/SubmitAttemptAnswers)
|
704
|
+
- [ ] [SubmitOfflineAttempt](https://api.agilixbuzz.com/docs/#!/Command/SubmitOfflineAttempt)
|
705
|
+
|
706
|
+
## Manifests and Items
|
707
|
+
|
708
|
+
- [ ] [AssignItem](https://api.agilixbuzz.com/docs/#!/Command/AssignItem)
|
709
|
+
- [ ] [CopyItems](https://api.agilixbuzz.com/docs/#!/Command/CopyItems)
|
710
|
+
- [ ] [DeleteItems](https://api.agilixbuzz.com/docs/#!/Command/DeleteItems)
|
711
|
+
- [ ] [FindPersonalizedEntities](https://api.agilixbuzz.com/docs/#!/Command/FindPersonalizedEntities)
|
712
|
+
- [ ] [GetCourseContent](https://api.agilixbuzz.com/docs/#!/Command/GetCourseContent)
|
713
|
+
- [ ] [GetItem](https://api.agilixbuzz.com/docs/#!/Command/GetItem)
|
714
|
+
- [ ] [GetItemInfo](https://api.agilixbuzz.com/docs/#!/Command/GetItemInfo)
|
715
|
+
- [ ] [GetItemLinks](https://api.agilixbuzz.com/docs/#!/Command/GetItemLinks)
|
716
|
+
- [ ] [GetItemList](https://api.agilixbuzz.com/docs/#!/Command/GetItemList)
|
717
|
+
- [ ] [GetManifest](https://api.agilixbuzz.com/docs/#!/Command/GetManifest)
|
718
|
+
- [ ] [GetManifestData](https://api.agilixbuzz.com/docs/#!/Command/GetManifestData)
|
719
|
+
- [ ] [GetManifestInfo](https://api.agilixbuzz.com/docs/#!/Command/GetManifestInfo)
|
720
|
+
- [ ] [GetManifestItem](https://api.agilixbuzz.com/docs/#!/Command/GetManifestItem)
|
721
|
+
- [ ] [ListAssignableItems](https://api.agilixbuzz.com/docs/#!/Command/ListAssignableItems)
|
722
|
+
- [ ] [ListRestorableItems](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableItems)
|
723
|
+
- [ ] [NavigateItem](https://api.agilixbuzz.com/docs/#!/Command/NavigateItem)
|
724
|
+
- [ ] [PutItems](https://api.agilixbuzz.com/docs/#!/Command/PutItems)
|
725
|
+
- [ ] [RestoreItems](https://api.agilixbuzz.com/docs/#!/Command/RestoreItems)
|
726
|
+
- [ ] [Search2](https://api.agilixbuzz.com/docs/#!/Command/Search2)
|
727
|
+
- [ ] [UnassignItem](https://api.agilixbuzz.com/docs/#!/Command/UnassignItem)
|
728
|
+
- [ ] [UpdateManifestData](https://api.agilixbuzz.com/docs/#!/Command/UpdateManifestData)
|
729
|
+
|
730
|
+
## Ratings
|
731
|
+
|
732
|
+
- [ ] [GetItemRating](https://api.agilixbuzz.com/docs/#!/Command/GetItemRating)
|
733
|
+
- [ ] [GetItemRatingSummary](https://api.agilixbuzz.com/docs/#!/Command/GetItemRatingSummary)
|
734
|
+
- [ ] [PutItemRating](https://api.agilixbuzz.com/docs/#!/Command/PutItemRating)
|
735
|
+
|
736
|
+
## Resources
|
737
|
+
|
738
|
+
- [ ] [DeleteDocuments](https://api.agilixbuzz.com/docs/#!/Command/DeleteDocuments)
|
739
|
+
- [ ] [GetDocument](https://api.agilixbuzz.com/docs/#!/Command/GetDocument)
|
740
|
+
- [ ] [GetDocumentInfo](https://api.agilixbuzz.com/docs/#!/Command/GetDocumentInfo)
|
741
|
+
- [ ] [ListRestorableDocuments](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableDocuments)
|
742
|
+
- [ ] [RestoreDocuments](https://api.agilixbuzz.com/docs/#!/Command/RestoreDocuments)
|
743
|
+
---
|
744
|
+
|
745
|
+
# Not Prioritized
|
746
|
+
|
747
|
+
## Announcements
|
748
|
+
|
749
|
+
- [ ] [DeleteAnnouncements](https://api.agilixbuzz.com/docs/#!/Command/DeleteAnnouncements)
|
750
|
+
- [ ] [GetAnnouncement](https://api.agilixbuzz.com/docs/#!/Command/GetAnnouncement)
|
751
|
+
- [ ] [GetAnnouncementInfo](https://api.agilixbuzz.com/docs/#!/Command/GetAnnouncementInfo)
|
752
|
+
- [ ] [GetAnnouncementList](https://api.agilixbuzz.com/docs/#!/Command/GetAnnouncementList)
|
753
|
+
- [ ] [GetUserAnnouncementList](https://api.agilixbuzz.com/docs/#!/Command/GetUserAnnouncementList)
|
754
|
+
- [ ] [ListRestorableAnnouncements](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableAnnouncements)
|
755
|
+
- [ ] [PutAnnouncement](https://api.agilixbuzz.com/docs/#!/Command/PutAnnouncement)
|
756
|
+
- [ ] [RestoreAnnouncements](https://api.agilixbuzz.com/docs/#!/Command/RestoreAnnouncements)
|
757
|
+
- [ ] [UpdateAnnouncementViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateAnnouncementViewed)
|
758
|
+
|
759
|
+
## Badges
|
760
|
+
|
761
|
+
- [ ] [CreateBadge](https://api.agilixbuzz.com/docs/#!/Command/CreateBadge)
|
762
|
+
- [ ] [DeleteBadge](https://api.agilixbuzz.com/docs/#!/Command/DeleteBadge)
|
763
|
+
- [ ] [GetBadge](https://api.agilixbuzz.com/docs/#!/Command/GetBadge)
|
764
|
+
- [ ] [GetBadgeAssertion](https://api.agilixbuzz.com/docs/#!/Command/GetBadgeAssertion)
|
765
|
+
- [ ] [GetBadgeList](https://api.agilixbuzz.com/docs/#!/Command/GetBadgeList)
|
766
|
+
|
767
|
+
## Blogs
|
768
|
+
|
769
|
+
- [ ] [DeleteBlogs](https://api.agilixbuzz.com/docs/#!/Command/DeleteBlogs)
|
770
|
+
- [ ] [GetBlog](https://api.agilixbuzz.com/docs/#!/Command/GetBlog)
|
771
|
+
- [ ] [GetBlogList](https://api.agilixbuzz.com/docs/#!/Command/GetBlogList)
|
772
|
+
- [ ] [GetBlogSummary](https://api.agilixbuzz.com/docs/#!/Command/GetBlogSummary)
|
773
|
+
- [ ] [GetRecentPosts](https://api.agilixbuzz.com/docs/#!/Command/GetRecentPosts)
|
774
|
+
- [ ] [PutBlog](https://api.agilixbuzz.com/docs/#!/Command/PutBlog)
|
775
|
+
- [ ] [UpdateBlogViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateBlogViewed)
|
776
|
+
|
777
|
+
## Command Tokens
|
778
|
+
|
779
|
+
- [ ] [CreateCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/CreateCommandTokens)
|
780
|
+
- [ ] [GetCommandToken](https://api.agilixbuzz.com/docs/#!/Command/GetCommandToken)
|
781
|
+
- [ ] [GetCommandTokenInfo](https://api.agilixbuzz.com/docs/#!/Command/GetCommandTokenInfo)
|
782
|
+
- [ ] [DeleteCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/DeleteCommandTokens)
|
783
|
+
- [ ] [UpdateCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/UpdateCommandTokens)
|
784
|
+
- [ ] [ListCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/ListCommandTokens)
|
785
|
+
- [ ] [RedeemCommandToken](https://api.agilixbuzz.com/docs/#!/Command/RedeemCommandToken)
|
786
|
+
|
787
|
+
## Conversion
|
788
|
+
|
789
|
+
- [ ] [ExportData](https://api.agilixbuzz.com/docs/#!/Command/ExportData)
|
790
|
+
- [ ] [GetConvertedData](https://api.agilixbuzz.com/docs/#!/Command/GetConvertedData)
|
791
|
+
- [ ] [ImportData](https://api.agilixbuzz.com/docs/#!/Command/ImportData)
|
792
|
+
|
793
|
+
## Discussion Boards
|
794
|
+
|
795
|
+
- [ ] [DeleteMessage](https://api.agilixbuzz.com/docs/#!/Command/DeleteMessage)
|
796
|
+
- [ ] [DeleteMessagePart](https://api.agilixbuzz.com/docs/#!/Command/DeleteMessagePart)
|
797
|
+
- [ ] [GetMessage](https://api.agilixbuzz.com/docs/#!/Command/GetMessage)
|
798
|
+
- [ ] [GetMessageList](https://api.agilixbuzz.com/docs/#!/Command/GetMessageList)
|
799
|
+
- [ ] [ListRestorableMessages](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableMessages)
|
800
|
+
- [ ] [PutMessage](https://api.agilixbuzz.com/docs/#!/Command/PutMessage)
|
801
|
+
- [ ] [PutMessagePart](https://api.agilixbuzz.com/docs/#!/Command/PutMessagePart)
|
802
|
+
- [ ] [RestoreMessages](https://api.agilixbuzz.com/docs/#!/Command/RestoreMessages)
|
803
|
+
- [ ] [SubmitMessage](https://api.agilixbuzz.com/docs/#!/Command/SubmitMessage)
|
804
|
+
- [ ] [UpdateMessageViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateMessageViewed)
|
805
|
+
|
806
|
+
## Groups
|
807
|
+
|
808
|
+
- [ ] [AddGroupMembers](https://api.agilixbuzz.com/docs/#!/Command/AddGroupMembers)
|
809
|
+
- [ ] [CreateGroups](https://api.agilixbuzz.com/docs/#!/Command/CreateGroups)
|
810
|
+
- [ ] [DeleteGroups](https://api.agilixbuzz.com/docs/#!/Command/DeleteGroups)
|
811
|
+
- [ ] [GetGroup](https://api.agilixbuzz.com/docs/#!/Command/GetGroup)
|
812
|
+
- [ ] [GetGroupEnrollmentList](https://api.agilixbuzz.com/docs/#!/Command/GetGroupEnrollmentList)
|
813
|
+
- [ ] [GetGroupList](https://api.agilixbuzz.com/docs/#!/Command/GetGroupList)
|
814
|
+
- [ ] [RemoveGroupMembers](https://api.agilixbuzz.com/docs/#!/Command/RemoveGroupMembers)
|
815
|
+
- [ ] [UpdateGroups](https://api.agilixbuzz.com/docs/#!/Command/UpdateGroups)
|
816
|
+
|
817
|
+
## Gradebook
|
818
|
+
|
819
|
+
- [ ] [CalculateEnrollmentScenario](https://api.agilixbuzz.com/docs/#!/Command/CalculateEnrollmentScenario)
|
820
|
+
- [ ] [GetCalendar](https://api.agilixbuzz.com/docs/#!/Command/GetCalendar)
|
821
|
+
- [ ] [GetCalendarItems](https://api.agilixbuzz.com/docs/#!/Command/GetCalendarItems)
|
822
|
+
- [ ] [GetCalendarToken](https://api.agilixbuzz.com/docs/#!/Command/GetCalendarToken)
|
823
|
+
- [ ] [GetCertificates](https://api.agilixbuzz.com/docs/#!/Command/GetCertificates)
|
824
|
+
- [ ] [GetDueSoonList](https://api.agilixbuzz.com/docs/#!/Command/GetDueSoonList)
|
825
|
+
- [ ] [GetEntityGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetEntityGradebook2)
|
826
|
+
- [ ] [GetEntityGradebook3](https://api.agilixbuzz.com/docs/#!/Command/GetEntityGradebook3)
|
827
|
+
- [ ] [GetEntityGradebookSummary](https://api.agilixbuzz.com/docs/#!/Command/GetEntityGradebookSummary)
|
828
|
+
- [ ] [GetEntityWork2](https://api.agilixbuzz.com/docs/#!/Command/GetEntityWork2)
|
829
|
+
- [ ] [GetGrade](https://api.agilixbuzz.com/docs/#!/Command/GetGrade)
|
830
|
+
- [ ] [GetGradebookList](https://api.agilixbuzz.com/docs/#!/Command/GetGradebookList)
|
831
|
+
- [ ] [GetGradebookSummary](https://api.agilixbuzz.com/docs/#!/Command/GetGradebookSummary)
|
832
|
+
- [ ] [GetGradebookWeights](https://api.agilixbuzz.com/docs/#!/Command/GetGradebookWeights)
|
833
|
+
- [ ] [GetGradeHistory](https://api.agilixbuzz.com/docs/#!/Command/GetGradeHistory)
|
834
|
+
- [ ] [GetItemAnalysis2](https://api.agilixbuzz.com/docs/#!/Command/GetItemAnalysis2)
|
835
|
+
- [ ] [GetItemReport](https://api.agilixbuzz.com/docs/#!/Command/GetItemReport)
|
836
|
+
- [ ] [GetRubricMastery](https://api.agilixbuzz.com/docs/#!/Command/GetRubricMastery)
|
837
|
+
- [ ] [GetRubricStats](https://api.agilixbuzz.com/docs/#!/Command/GetRubricStats)
|
838
|
+
- [ ] [GetUserGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetUserGradebook2)
|
839
|
+
|
840
|
+
## Objectives
|
841
|
+
|
842
|
+
- [ ] [CreateObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/CreateObjectiveSets)
|
843
|
+
- [ ] [DeleteObjectiveMaps](https://api.agilixbuzz.com/docs/#!/Command/DeleteObjectiveMaps)
|
844
|
+
- [ ] [DeleteObjectives](https://api.agilixbuzz.com/docs/#!/Command/DeleteObjectives)
|
845
|
+
- [ ] [DeleteObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/DeleteObjectiveSets)
|
846
|
+
- [ ] [GetMasteryDetail](https://api.agilixbuzz.com/docs/#!/Command/GetMasteryDetail)
|
847
|
+
- [ ] [GetMasterySummary](https://api.agilixbuzz.com/docs/#!/Command/GetMasterySummary)
|
848
|
+
- [ ] [GetObjectiveList](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveList)
|
849
|
+
- [ ] [GetObjectiveMapList](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveMapList)
|
850
|
+
- [ ] [GetObjectiveMastery](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveMastery)
|
851
|
+
- [ ] [GetObjectiveSet2](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveSet2)
|
852
|
+
- [ ] [GetObjectiveSubjectList](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveSubjectList)
|
853
|
+
- [ ] [ListObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/ListObjectiveSets)
|
854
|
+
- [ ] [PutObjectiveMaps](https://api.agilixbuzz.com/docs/#!/Command/PutObjectiveMaps)
|
855
|
+
- [ ] [PutObjectives](https://api.agilixbuzz.com/docs/#!/Command/PutObjectives)
|
856
|
+
- [ ] [RestoreObjectiveSet](https://api.agilixbuzz.com/docs/#!/Command/RestoreObjectiveSet)
|
857
|
+
- [ ] [UpdateObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/UpdateObjectiveSets)
|
858
|
+
|
859
|
+
## Peer Grading
|
860
|
+
|
861
|
+
- [ ] [GetPeerResponse](https://api.agilixbuzz.com/docs/#!/Command/GetPeerResponse)
|
862
|
+
- [ ] [GetPeerResponseInfo](https://api.agilixbuzz.com/docs/#!/Command/GetPeerResponseInfo)
|
863
|
+
- [ ] [GetPeerResponseList](https://api.agilixbuzz.com/docs/#!/Command/GetPeerResponseList)
|
864
|
+
- [ ] [GetPeerReviewList](https://api.agilixbuzz.com/docs/#!/Command/GetPeerReviewList)
|
865
|
+
- [ ] [PutPeerResponse](https://api.agilixbuzz.com/docs/#!/Command/PutPeerResponse)
|
866
|
+
|
867
|
+
## Signals
|
868
|
+
|
869
|
+
- [ ] [CreateSignal](https://api.agilixbuzz.com/docs/#!/Command/CreateSignal)
|
870
|
+
- [ ] [GetLastSignalId](https://api.agilixbuzz.com/docs/#!/Command/GetLastSignalId)
|
871
|
+
- [ ] [GetSignalList2](https://api.agilixbuzz.com/docs/#!/Command/GetSignalList2)
|
872
|
+
|
873
|
+
## Submissions
|
874
|
+
|
875
|
+
- [ ] [DeleteWorkInProgress](https://api.agilixbuzz.com/docs/#!/Command/DeleteWorkInProgress)
|
876
|
+
- [ ] [GenerateSubmission](https://api.agilixbuzz.com/docs/#!/Command/GenerateSubmission)
|
877
|
+
- [ ] [GetScoData](https://api.agilixbuzz.com/docs/#!/Command/GetScoData)
|
878
|
+
- [ ] [GetStudentSubmission](https://api.agilixbuzz.com/docs/#!/Command/GetStudentSubmission)
|
879
|
+
- [ ] [GetStudentSubmissionHistory](https://api.agilixbuzz.com/docs/#!/Command/GetStudentSubmissionHistory)
|
880
|
+
- [ ] [GetStudentSubmissionInfo](https://api.agilixbuzz.com/docs/#!/Command/GetStudentSubmissionInfo)
|
881
|
+
- [ ] [GetTeacherResponse](https://api.agilixbuzz.com/docs/#!/Command/GetTeacherResponse)
|
882
|
+
- [ ] [GetTeacherResponseInfo](https://api.agilixbuzz.com/docs/#!/Command/GetTeacherResponseInfo)
|
883
|
+
- [ ] [GetWorkInProgress2](https://api.agilixbuzz.com/docs/#!/Command/GetWorkInProgress2)
|
884
|
+
- [ ] [PutItemActivity](https://api.agilixbuzz.com/docs/#!/Command/PutItemActivity)
|
885
|
+
- [ ] [PutScoData](https://api.agilixbuzz.com/docs/#!/Command/PutScoData)
|
886
|
+
- [ ] [PutStudentSubmission](https://api.agilixbuzz.com/docs/#!/Command/PutStudentSubmission)
|
887
|
+
- [ ] [PutTeacherResponse](https://api.agilixbuzz.com/docs/#!/Command/PutTeacherResponse)
|
888
|
+
- [ ] [PutTeacherResponses](https://api.agilixbuzz.com/docs/#!/Command/PutTeacherResponses)
|
889
|
+
- [ ] [PutWorkInProgress](https://api.agilixbuzz.com/docs/#!/Command/PutWorkInProgress)
|
890
|
+
- [ ] [SubmitWorkInProgress](https://api.agilixbuzz.com/docs/#!/Command/SubmitWorkInProgress)
|
891
|
+
|
892
|
+
## Wikis
|
893
|
+
|
894
|
+
- [ ] [CopyWikiPages](https://api.agilixbuzz.com/docs/#!/Command/CopyWikiPages)
|
895
|
+
- [ ] [DeleteWikiPages](https://api.agilixbuzz.com/docs/#!/Command/DeleteWikiPages)
|
896
|
+
- [ ] [GetWikiPage](https://api.agilixbuzz.com/docs/#!/Command/GetWikiPage)
|
897
|
+
- [ ] [GetWikiPageList](https://api.agilixbuzz.com/docs/#!/Command/GetWikiPageList)
|
898
|
+
- [ ] [ListRestorableWikiPages](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableWikiPages)
|
899
|
+
- [ ] [PutWikiPage](https://api.agilixbuzz.com/docs/#!/Command/PutWikiPage)
|
900
|
+
- [ ] [RestoreWikiPages](https://api.agilixbuzz.com/docs/#!/Command/RestoreWikiPages)
|
901
|
+
- [ ] [UpdateWikiPageViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateWikiPageViewed)
|
902
|
+
|
903
|
+
|
904
|
+
## Features
|
905
|
+
|
906
|
+
Implemented APIs from [Agilix Buzz API Docs](https://api.agilixbuzz.com/)
|
907
|
+
|
908
|
+
(Last updated on March 7, 2019)
|
909
|
+
|
910
|
+
| API | Methods & Docs | Implemented? | Priority |
|
911
|
+
| --- | --- | --- | --- |
|
912
|
+
| Announcements | [DeleteAnnouncements](https://api.agilixbuzz.com/docs/#!/Command/DeleteAnnouncements), [GetAnnouncement](https://api.agilixbuzz.com/docs/#!/Command/GetAnnouncement), [GetAnnouncementInfo](https://api.agilixbuzz.com/docs/#!/Command/GetAnnouncementInfo), [GetAnnouncementList](https://api.agilixbuzz.com/docs/#!/Command/GetAnnouncementList), [GetUserAnnouncementList](https://api.agilixbuzz.com/docs/#!/Command/GetUserAnnouncementList), [ListRestorableAnnouncements](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableAnnouncements), [PutAnnouncement](https://api.agilixbuzz.com/docs/#!/Command/PutAnnouncement), [RestoreAnnouncements](https://api.agilixbuzz.com/docs/#!/Command/RestoreAnnouncements), [UpdateAnnouncementViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateAnnouncementViewed) | β | πΌ |
|
913
|
+
| Assessments | [DeleteQuestions](https://api.agilixbuzz.com/docs/#!/Command/DeleteQuestions), [GetAttempt](https://api.agilixbuzz.com/docs/#!/Command/GetAttempt), [GetAttemptReview](https://api.agilixbuzz.com/docs/#!/Command/GetAttemptReview), [GetExam](https://api.agilixbuzz.com/docs/#!/Command/GetExam), [GetNextQuestion](https://api.agilixbuzz.com/docs/#!/Command/GetNextQuestion), [GetQuestion](https://api.agilixbuzz.com/docs/#!/Command/GetQuestion), [GetQuestionScores](https://api.agilixbuzz.com/docs/#!/Command/GetQuestionScores), [GetQuestionStats](https://api.agilixbuzz.com/docs/#!/Command/GetQuestionStats), [GetSubmissionState](https://api.agilixbuzz.com/docs/#!/Command/GetSubmissionState), [ListQuestions](https://api.agilixbuzz.com/docs/#!/Command/ListQuestions), [ListRestorableQuestions](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableQuestions), [PrepareOfflineAttempt](https://api.agilixbuzz.com/docs/#!/Command/PrepareOfflineAttempt), [PutQuestions](https://api.agilixbuzz.com/docs/#!/Command/PutQuestions), [RestoreQuestions](https://api.agilixbuzz.com/docs/#!/Command/RestoreQuestions), [SaveAttemptAnswers](https://api.agilixbuzz.com/docs/#!/Command/SaveAttemptAnswers), [SubmitAttemptAnswers](https://api.agilixbuzz.com/docs/#!/Command/SubmitAttemptAnswers), [SubmitOfflineAttempt](https://api.agilixbuzz.com/docs/#!/Command/SubmitOfflineAttempt) | β | βΊ |
|
914
|
+
| Authentication | [ExtendSession](https://api.agilixbuzz.com/docs/#!/Command/ExtendSession), [GetKey](https://api.agilixbuzz.com/docs/#!/Command/GetKey), [ForcePasswordChange](https://api.agilixbuzz.com/docs/#!/Command/ForcePasswordChange), [GetPasswordLoginAttemptHistory](https://api.agilixbuzz.com/docs/#!/Command/GetPasswordLoginAttemptHistory), [GetPasswordPolicy](https://api.agilixbuzz.com/docs/#!/Command/GetPasswordPolicy), [GetPasswordQuestion](https://api.agilixbuzz.com/docs/#!/Command/GetPasswordQuestion), [Login2](https://api.agilixbuzz.com/docs/#!/Command/Login2), [Logout](https://api.agilixbuzz.com/docs/#!/Command/Logout), [Proxy](https://api.agilixbuzz.com/docs/#!/Command/Proxy), [PutKey](https://api.agilixbuzz.com/docs/#!/Command/PutKey), [ResetLockout](https://api.agilixbuzz.com/docs/#!/Command/ResetLockout), [ResetPassword](https://api.agilixbuzz.com/docs/#!/Command/ResetPassword), [Unproxy](https://api.agilixbuzz.com/docs/#!/Command/Unproxy), [UpdatePassword](https://api.agilixbuzz.com/docs/#!/Command/UpdatePassword), [UpdatePasswordQuestionAnswer](https://api.agilixbuzz.com/docs/#!/Command/UpdatePasswordQuestionAnswer) | β | πΌ |
|
915
|
+
| Badges | [CreateBadge](https://api.agilixbuzz.com/docs/#!/Command/CreateBadge), [DeleteBadge](https://api.agilixbuzz.com/docs/#!/Command/DeleteBadge), [GetBadge](https://api.agilixbuzz.com/docs/#!/Command/GetBadge), [GetBadgeAssertion](https://api.agilixbuzz.com/docs/#!/Command/GetBadgeAssertion), [GetBadgeList](https://api.agilixbuzz.com/docs/#!/Command/GetBadgeList) | β | π½ |
|
916
|
+
| Blogs | [DeleteBlogs](https://api.agilixbuzz.com/docs/#!/Command/DeleteBlogs), [GetBlog](https://api.agilixbuzz.com/docs/#!/Command/GetBlog), [GetBlogList](https://api.agilixbuzz.com/docs/#!/Command/GetBlogList), [GetBlogSummary](https://api.agilixbuzz.com/docs/#!/Command/GetBlogSummary), [GetRecentPosts](https://api.agilixbuzz.com/docs/#!/Command/GetRecentPosts), [PutBlog](https://api.agilixbuzz.com/docs/#!/Command/PutBlog), [UpdateBlogViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateBlogViewed) | β | β¬ |
|
917
|
+
| Command Tokens | [CreateCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/CreateCommandTokens), [GetCommandToken](https://api.agilixbuzz.com/docs/#!/Command/GetCommandToken), [GetCommandTokenInfo](https://api.agilixbuzz.com/docs/#!/Command/GetCommandTokenInfo), [DeleteCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/DeleteCommandTokens), [UpdateCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/UpdateCommandTokens), [ListCommandTokens](https://api.agilixbuzz.com/docs/#!/Command/ListCommandTokens), [RedeemCommandToken](https://api.agilixbuzz.com/docs/#!/Command/RedeemCommandToken) | β | β¬
|
918
|
+
| Conversion | [ExportData](https://api.agilixbuzz.com/docs/#!/Command/ExportData), [GetConvertedData](https://api.agilixbuzz.com/docs/#!/Command/GetConvertedData), [ImportData](https://api.agilixbuzz.com/docs/#!/Command/ImportData) | β | β¬ |
|
919
|
+
| Courses | [CopyCourses](https://api.agilixbuzz.com/docs/#!/Command/CopyCourses), [CreateCourses](https://api.agilixbuzz.com/docs/#!/Command/CreateCourses), [CreateDemoCourse](https://api.agilixbuzz.com/docs/#!/Command/CreateDemoCourse), [DeactivateCourse](https://api.agilixbuzz.com/docs/#!/Command/DeactivateCourse), [DeleteCourses](https://api.agilixbuzz.com/docs/#!/Command/DeleteCourses), [GetCourse2](https://api.agilixbuzz.com/docs/#!/Command/GetCourse2), [GetCourseHistory](https://api.agilixbuzz.com/docs/#!/Command/GetCourseHistory), [ListCourses](https://api.agilixbuzz.com/docs/#!/Command/ListCourses), [MergeCourses](https://api.agilixbuzz.com/docs/#!/Command/MergeCourses), [RestoreCourse](https://api.agilixbuzz.com/docs/#!/Command/RestoreCourse), [UpdateCourses](https://api.agilixbuzz.com/docs/#!/Command/UpdateCourses) | β | πΌ |
|
920
|
+
| Discussion Boards | [DeleteMessage](https://api.agilixbuzz.com/docs/#!/Command/DeleteMessage), [DeleteMessagePart](https://api.agilixbuzz.com/docs/#!/Command/DeleteMessagePart), [GetMessage](https://api.agilixbuzz.com/docs/#!/Command/GetMessage), [GetMessageList](https://api.agilixbuzz.com/docs/#!/Command/GetMessageList), [ListRestorableMessages](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableMessages), [PutMessage](https://api.agilixbuzz.com/docs/#!/Command/PutMessage), [PutMessagePart](https://api.agilixbuzz.com/docs/#!/Command/PutMessagePart), [RestoreMessages](https://api.agilixbuzz.com/docs/#!/Command/RestoreMessages), [SubmitMessage](https://api.agilixbuzz.com/docs/#!/Command/SubmitMessage), [UpdateMessageViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateMessageViewed) | β | π½
|
921
|
+
| Domains | [CreateDomains](https://api.agilixbuzz.com/docs/#!/Command/CreateDomains), [DeleteDomain](https://api.agilixbuzz.com/docs/#!/Command/DeleteDomain), [GetDomain2](https://api.agilixbuzz.com/docs/#!/Command/GetDomain2), [GetDomainContent](https://api.agilixbuzz.com/docs/#!/Command/GetDomainContent), [GetDomainEnrollmentMetrics](https://api.agilixbuzz.com/docs/#!/Command/GetDomainEnrollmentMetrics), [GetDomainParentList](https://api.agilixbuzz.com/docs/#!/Command/GetDomainParentList), [GetDomainSettings](https://api.agilixbuzz.com/docs/#!/Command/GetDomainSettings), [GetDomainStats](https://api.agilixbuzz.com/docs/#!/Command/GetDomainStats), [ListDomains](https://api.agilixbuzz.com/docs/#!/Command/ListDomains), [RestoreDomain](https://api.agilixbuzz.com/docs/#!/Command/RestoreDomain), [UpdateDomains](https://api.agilixbuzz.com/docs/#!/Command/UpdateDomains) | β
| β« |
|
922
|
+
| Enrollments | [CreateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/CreateEnrollments), [DeleteEnrollments](https://api.agilixbuzz.com/docs/#!/Command/DeleteEnrollments), [GetEnrollment3](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollment3), [GetEnrollmentActivity](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentActivity), [GetEnrollmentGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGradebook2), [GetEnrollmentGroupList](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGroupList), [GetEnrollmentMetricsReport](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentMetricsReport), [ListEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollments), [ListEnrollmentsByTeacher](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollmentsByTeacher), [ListEntityEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEntityEnrollments), [ListUserEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListUserEnrollments), [PutSelfAssessment](https://api.agilixbuzz.com/docs/#!/Command/PutSelfAssessment), [RestoreEnrollment](https://api.agilixbuzz.com/docs/#!/Command/RestoreEnrollment), [UpdateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/UpdateEnrollments) | β | πΌ |
|
923
|
+
| General | [Echo](https://api.agilixbuzz.com/docs/#!/Command/Echo), [GetCommandList](https://api.agilixbuzz.com/docs/#!/Command/GetCommandList), [GetEntityType](https://api.agilixbuzz.com/docs/#!/Command/GetEntityType), [GetStatus](https://api.agilixbuzz.com/docs/#!/Command/GetStatus), [GetUploadLimits](https://api.agilixbuzz.com/docs/#!/Command/GetUploadLimits), [SendMail](https://api.agilixbuzz.com/docs/#!/Command/SendMail) | β | βΊ |
|
924
|
+
| Groups | [AddGroupMembers](https://api.agilixbuzz.com/docs/#!/Command/AddGroupMembers), [CreateGroups](https://api.agilixbuzz.com/docs/#!/Command/CreateGroups), [DeleteGroups](https://api.agilixbuzz.com/docs/#!/Command/DeleteGroups), [GetGroup](https://api.agilixbuzz.com/docs/#!/Command/GetGroup), [GetGroupEnrollmentList](https://api.agilixbuzz.com/docs/#!/Command/GetGroupEnrollmentList), [GetGroupList](https://api.agilixbuzz.com/docs/#!/Command/GetGroupList), [RemoveGroupMembers](https://api.agilixbuzz.com/docs/#!/Command/RemoveGroupMembers), [UpdateGroups](https://api.agilixbuzz.com/docs/#!/Command/UpdateGroups) | β | β¬ |
|
925
|
+
| Gradebook | [CalculateEnrollmentScenario](https://api.agilixbuzz.com/docs/#!/Command/CalculateEnrollmentScenario), [GetCalendar](https://api.agilixbuzz.com/docs/#!/Command/GetCalendar), [GetCalendarItems](https://api.agilixbuzz.com/docs/#!/Command/GetCalendarItems), [GetCalendarToken](https://api.agilixbuzz.com/docs/#!/Command/GetCalendarToken), [GetCertificates](https://api.agilixbuzz.com/docs/#!/Command/GetCertificates), [GetDueSoonList](https://api.agilixbuzz.com/docs/#!/Command/GetDueSoonList), [GetEntityGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetEntityGradebook2), [GetEntityGradebook3](https://api.agilixbuzz.com/docs/#!/Command/GetEntityGradebook3), [GetEntityGradebookSummary](https://api.agilixbuzz.com/docs/#!/Command/GetEntityGradebookSummary), [GetEntityWork2](https://api.agilixbuzz.com/docs/#!/Command/GetEntityWork2), [GetGrade](https://api.agilixbuzz.com/docs/#!/Command/GetGrade), [GetGradebookList](https://api.agilixbuzz.com/docs/#!/Command/GetGradebookList), [GetGradebookSummary](https://api.agilixbuzz.com/docs/#!/Command/GetGradebookSummary), [GetGradebookWeights](https://api.agilixbuzz.com/docs/#!/Command/GetGradebookWeights), [GetGradeHistory](https://api.agilixbuzz.com/docs/#!/Command/GetGradeHistory), [GetItemAnalysis2](https://api.agilixbuzz.com/docs/#!/Command/GetItemAnalysis2), [GetItemReport](https://api.agilixbuzz.com/docs/#!/Command/GetItemReport), [GetRubricMastery](https://api.agilixbuzz.com/docs/#!/Command/GetRubricMastery), [GetRubricStats](https://api.agilixbuzz.com/docs/#!/Command/GetRubricStats), [GetUserGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetUserGradebook2) | β | π½ |
|
926
|
+
| Manifests and Items | [AssignItem](https://api.agilixbuzz.com/docs/#!/Command/AssignItem), [CopyItems](https://api.agilixbuzz.com/docs/#!/Command/CopyItems), [DeleteItems](https://api.agilixbuzz.com/docs/#!/Command/DeleteItems), [FindPersonalizedEntities](https://api.agilixbuzz.com/docs/#!/Command/FindPersonalizedEntities), [GetCourseContent](https://api.agilixbuzz.com/docs/#!/Command/GetCourseContent), [GetItem](https://api.agilixbuzz.com/docs/#!/Command/GetItem), [GetItemInfo](https://api.agilixbuzz.com/docs/#!/Command/GetItemInfo), [GetItemLinks](https://api.agilixbuzz.com/docs/#!/Command/GetItemLinks), [GetItemList](https://api.agilixbuzz.com/docs/#!/Command/GetItemList), [GetManifest](https://api.agilixbuzz.com/docs/#!/Command/GetManifest), [GetManifestData](https://api.agilixbuzz.com/docs/#!/Command/GetManifestData), [GetManifestInfo](https://api.agilixbuzz.com/docs/#!/Command/GetManifestInfo), [GetManifestItem](https://api.agilixbuzz.com/docs/#!/Command/GetManifestItem), [ListAssignableItems](https://api.agilixbuzz.com/docs/#!/Command/ListAssignableItems), [ListRestorableItems](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableItems), [NavigateItem](https://api.agilixbuzz.com/docs/#!/Command/NavigateItem), [PutItems](https://api.agilixbuzz.com/docs/#!/Command/PutItems), [RestoreItems](https://api.agilixbuzz.com/docs/#!/Command/RestoreItems), [Search2](https://api.agilixbuzz.com/docs/#!/Command/Search2), [UnassignItem](https://api.agilixbuzz.com/docs/#!/Command/UnassignItem), [UpdateManifestData](https://api.agilixbuzz.com/docs/#!/Command/UpdateManifestData) | β | βΊ |
|
927
|
+
| Objectives | [CreateObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/CreateObjectiveSets), [DeleteObjectiveMaps](https://api.agilixbuzz.com/docs/#!/Command/DeleteObjectiveMaps), [DeleteObjectives](https://api.agilixbuzz.com/docs/#!/Command/DeleteObjectives), [DeleteObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/DeleteObjectiveSets), [GetMasteryDetail](https://api.agilixbuzz.com/docs/#!/Command/GetMasteryDetail), [GetMasterySummary](https://api.agilixbuzz.com/docs/#!/Command/GetMasterySummary), [GetObjectiveList](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveList), [GetObjectiveMapList](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveMapList), [GetObjectiveMastery](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveMastery), [GetObjectiveSet2](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveSet2), [GetObjectiveSubjectList](https://api.agilixbuzz.com/docs/#!/Command/GetObjectiveSubjectList), [ListObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/ListObjectiveSets), [PutObjectiveMaps](https://api.agilixbuzz.com/docs/#!/Command/PutObjectiveMaps), [PutObjectives](https://api.agilixbuzz.com/docs/#!/Command/PutObjectives), [RestoreObjectiveSet](https://api.agilixbuzz.com/docs/#!/Command/RestoreObjectiveSet), [UpdateObjectiveSets](https://api.agilixbuzz.com/docs/#!/Command/UpdateObjectiveSets) | β | β¬ |
|
928
|
+
| Peer Grading | [GetPeerResponse](https://api.agilixbuzz.com/docs/#!/Command/GetPeerResponse), [GetPeerResponseInfo](https://api.agilixbuzz.com/docs/#!/Command/GetPeerResponseInfo), [GetPeerResponseList](https://api.agilixbuzz.com/docs/#!/Command/GetPeerResponseList), [GetPeerReviewList](https://api.agilixbuzz.com/docs/#!/Command/GetPeerReviewList), [PutPeerResponse](https://api.agilixbuzz.com/docs/#!/Command/PutPeerResponse) | β | β¬
|
929
|
+
| Ratings | [GetItemRating](https://api.agilixbuzz.com/docs/#!/Command/GetItemRating), [GetItemRatingSummary](https://api.agilixbuzz.com/docs/#!/Command/GetItemRatingSummary), [PutItemRating](https://api.agilixbuzz.com/docs/#!/Command/PutItemRating) | β | βΊ |
|
930
|
+
| Reports | [GetReportInfo](https://api.agilixbuzz.com/docs/#!/Command/GetReportInfo), [GetReportList](https://api.agilixbuzz.com/docs/#!/Command/GetReportList), [GetRunnableReportList](https://api.agilixbuzz.com/docs/#!/Command/GetRunnableReportList), [RunReport](https://api.agilixbuzz.com/docs/#!/Command/RunReport) | β | β« |
|
931
|
+
| Resources | [CopyResources](https://api.agilixbuzz.com/docs/#!/Command/CopyResources), [DeleteDocuments](https://api.agilixbuzz.com/docs/#!/Command/DeleteDocuments), [DeleteResources](https://api.agilixbuzz.com/docs/#!/Command/DeleteResources), [GetDocument](https://api.agilixbuzz.com/docs/#!/Command/GetDocument), [GetDocumentInfo](https://api.agilixbuzz.com/docs/#!/Command/GetDocumentInfo), [GetEntityResourceId](https://api.agilixbuzz.com/docs/#!/Command/GetEntityResourceId), [GetResource](https://api.agilixbuzz.com/docs/#!/Command/GetResource), [GetResourceInfo2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceInfo2), [GetResourceList2](https://api.agilixbuzz.com/docs/#!/Command/GetResourceList2), [ListRestorableDocuments](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableDocuments), [ListRestorableResources](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableResources), [PutResource](https://api.agilixbuzz.com/docs/#!/Command/PutResource), [PutResourceFolders](https://api.agilixbuzz.com/docs/#!/Command/PutResourceFolders), [RestoreDocuments](https://api.agilixbuzz.com/docs/#!/Command/RestoreDocuments), [RestoreResources](https://api.agilixbuzz.com/docs/#!/Command/RestoreResources) | β | βΊ |
|
932
|
+
| Rights | [CreateRole](https://api.agilixbuzz.com/docs/#!/Command/CreateRole), [DeleteRole](https://api.agilixbuzz.com/docs/#!/Command/DeleteRole), [DeleteSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/DeleteSubscriptions), [GetActorRights](https://api.agilixbuzz.com/docs/#!/Command/GetActorRights), [GetEffectiveRights](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveRights), [GetEffectiveSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEffectiveSubscriptionList), [GetEntityRights](https://api.agilixbuzz.com/docs/#!/Command/GetEntityRights), [GetEntitySubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetEntitySubscriptionList), [GetPersonas](https://api.agilixbuzz.com/docs/#!/Command/GetPersonas), [GetRights](https://api.agilixbuzz.com/docs/#!/Command/GetRights), [GetRightsList](https://api.agilixbuzz.com/docs/#!/Command/GetRightsList), [GetRole](https://api.agilixbuzz.com/docs/#!/Command/GetRole), [GetSubscriptionList](https://api.agilixbuzz.com/docs/#!/Command/GetSubscriptionList), [ListRoles](https://api.agilixbuzz.com/docs/#!/Command/ListRoles), [RestoreRole](https://api.agilixbuzz.com/docs/#!/Command/RestoreRole), [UpdateRights](https://api.agilixbuzz.com/docs/#!/Command/UpdateRights), [UpdateRole](https://api.agilixbuzz.com/docs/#!/Command/UpdateRole), [UpdateSubscriptions](https://api.agilixbuzz.com/docs/#!/Command/UpdateSubscriptions) | β | πΌ |
|
933
|
+
| Signals | [CreateSignal](https://api.agilixbuzz.com/docs/#!/Command/CreateSignal), [GetLastSignalId](https://api.agilixbuzz.com/docs/#!/Command/GetLastSignalId), [GetSignalList2](https://api.agilixbuzz.com/docs/#!/Command/GetSignalList2) | β | π½ |
|
934
|
+
| Submissions | [DeleteWorkInProgress](https://api.agilixbuzz.com/docs/#!/Command/DeleteWorkInProgress), [GenerateSubmission](https://api.agilixbuzz.com/docs/#!/Command/GenerateSubmission), [GetScoData](https://api.agilixbuzz.com/docs/#!/Command/GetScoData), [GetStudentSubmission](https://api.agilixbuzz.com/docs/#!/Command/GetStudentSubmission), [GetStudentSubmissionHistory](https://api.agilixbuzz.com/docs/#!/Command/GetStudentSubmissionHistory), [GetStudentSubmissionInfo](https://api.agilixbuzz.com/docs/#!/Command/GetStudentSubmissionInfo), [GetTeacherResponse](https://api.agilixbuzz.com/docs/#!/Command/GetTeacherResponse), [GetTeacherResponseInfo](https://api.agilixbuzz.com/docs/#!/Command/GetTeacherResponseInfo), [GetWorkInProgress2](https://api.agilixbuzz.com/docs/#!/Command/GetWorkInProgress2), [PutItemActivity](https://api.agilixbuzz.com/docs/#!/Command/PutItemActivity), [PutScoData](https://api.agilixbuzz.com/docs/#!/Command/PutScoData), [PutStudentSubmission](https://api.agilixbuzz.com/docs/#!/Command/PutStudentSubmission), [PutTeacherResponse](https://api.agilixbuzz.com/docs/#!/Command/PutTeacherResponse), [PutTeacherResponses](https://api.agilixbuzz.com/docs/#!/Command/PutTeacherResponses), [PutWorkInProgress](https://api.agilixbuzz.com/docs/#!/Command/PutWorkInProgress), [SubmitWorkInProgress](https://api.agilixbuzz.com/docs/#!/Command/SubmitWorkInProgress) | β | π½ |
|
935
|
+
| Users | [CreateUsers2](https://api.agilixbuzz.com/docs/#!/Command/CreateUsers2), [DeleteUsers](https://api.agilixbuzz.com/docs/#!/Command/DeleteUsers), [GetActiveUserCount](https://api.agilixbuzz.com/docs/#!/Command/GetActiveUserCount), [GetDomainActivity](https://api.agilixbuzz.com/docs/#!/Command/GetDomainActivity), [GetProfilePicture](https://api.agilixbuzz.com/docs/#!/Command/GetProfilePicture), [GetUser2](https://api.agilixbuzz.com/docs/#!/Command/GetUser2), [GetUserActivity](https://api.agilixbuzz.com/docs/#!/Command/GetUserActivity), [GetUserActivityStream](https://api.agilixbuzz.com/docs/#!/Command/GetUserActivityStream), [ListUsers](https://api.agilixbuzz.com/docs/#!/Command/ListUsers), [RestoreUser](https://api.agilixbuzz.com/docs/#!/Command/RestoreUser), [UpdateUsers](https://api.agilixbuzz.com/docs/#!/Command/UpdateUsers) | β | β« |
|
936
|
+
| Wikis | [CopyWikiPages](https://api.agilixbuzz.com/docs/#!/Command/CopyWikiPages), [DeleteWikiPages](https://api.agilixbuzz.com/docs/#!/Command/DeleteWikiPages), [GetWikiPage](https://api.agilixbuzz.com/docs/#!/Command/GetWikiPage), [GetWikiPageList](https://api.agilixbuzz.com/docs/#!/Command/GetWikiPageList), [ListRestorableWikiPages](https://api.agilixbuzz.com/docs/#!/Command/ListRestorableWikiPages), [PutWikiPage](https://api.agilixbuzz.com/docs/#!/Command/PutWikiPage), [RestoreWikiPages](https://api.agilixbuzz.com/docs/#!/Command/RestoreWikiPages), [UpdateWikiPageViewed](https://api.agilixbuzz.com/docs/#!/Command/UpdateWikiPageViewed) | β | β¬ |
|
937
|
+
| Example Name | Example Description | β
or β | β«πΌβΊπ½β¬ |
|
938
|
+
|
939
|
+
## Development
|
940
|
+
|
941
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
942
|
+
|
943
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
944
|
+
|
945
|
+
## Contributing
|
946
|
+
|
947
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/beneggett/agilix. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
948
|
+
|
949
|
+
## License
|
950
|
+
|
951
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
952
|
+
|
953
|
+
## Code of Conduct
|
954
|
+
|
955
|
+
Everyone interacting in the Agilix::Buzz projectβs codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/agilix/blob/master/CODE_OF_CONDUCT.md).
|