lms-api 1.2.4 → 1.2.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lms/canvas.rb +11 -0
- data/lib/lms/canvas_urls.rb +31 -20
- data/lib/lms/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8699e71f9fd9af29ca9009c10396cde4cb6848d6
|
|
4
|
+
data.tar.gz: 059b052a2d0aee31634870e07938e91b18917406
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 83e4840238c25bd7ed17a8224020281e77f99e3415c829642778c01687cdf3b8dcc97c848e147421215d734edd983170b0d81823f632cbb71eb3c3b99777df97
|
|
7
|
+
data.tar.gz: 1ad2e5fa55b31f947936d97044a4ad6de73f4d3912a1de6771f5136d7e562173a2f517918f2a5fbee801cca4ba9c7b4affb1006321d8d93a94d5b40a74ec8ef7
|
data/lib/lms/canvas.rb
CHANGED
|
@@ -8,6 +8,11 @@ require "active_support/core_ext/hash/indifferent_access"
|
|
|
8
8
|
require "lms/canvas_urls"
|
|
9
9
|
|
|
10
10
|
module LMS
|
|
11
|
+
|
|
12
|
+
CANVAS_HELPER_URLs = {
|
|
13
|
+
"HELPER_ALL_ACCOUNTS" => :all_accounts
|
|
14
|
+
}
|
|
15
|
+
|
|
11
16
|
class Canvas
|
|
12
17
|
|
|
13
18
|
# a model that encapsulates authentication state. By default, it
|
|
@@ -200,6 +205,12 @@ module LMS
|
|
|
200
205
|
end
|
|
201
206
|
|
|
202
207
|
def proxy(type, params, payload = nil, get_all = false)
|
|
208
|
+
|
|
209
|
+
# Helper methods call several Canvas methods to return a block of data to the client
|
|
210
|
+
if helper = CANVAS_HELPER_URLs[type]
|
|
211
|
+
return self.send(helper)
|
|
212
|
+
end
|
|
213
|
+
|
|
203
214
|
additional_headers = {
|
|
204
215
|
"Content-Type" => "application/json"
|
|
205
216
|
}
|
data/lib/lms/canvas_urls.rb
CHANGED
|
@@ -11,12 +11,12 @@ module LMS
|
|
|
11
11
|
"INDEX_OF_REPORTS" => { uri: ->(account_id:, report:) { "accounts/#{account_id}/reports/#{report}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"report", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
12
12
|
"STATUS_OF_REPORT" => { uri: ->(account_id:, report:, id:) { "accounts/#{account_id}/reports/#{report}/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"report", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
13
13
|
"DELETE_REPORT" => { uri: ->(account_id:, report:, id:) { "accounts/#{account_id}/reports/#{report}/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"report", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
14
|
-
"LIST_ACCOUNTS" => { uri: ->() { "accounts" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["lti_guid", "registration_settings"], "items"=>{"type"=>"string"}}] },
|
|
14
|
+
"LIST_ACCOUNTS" => { uri: ->() { "accounts" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["lti_guid", "registration_settings", "services"], "items"=>{"type"=>"string"}}] },
|
|
15
15
|
"LIST_ACCOUNTS_FOR_COURSE_ADMINS" => { uri: ->() { "course_accounts" }, method: "GET", parameters: [] },
|
|
16
16
|
"GET_SINGLE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
17
17
|
"GET_SUB_ACCOUNTS_OF_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/sub_accounts" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"recursive", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
18
18
|
"LIST_ACTIVE_COURSES_IN_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"with_enrollments", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"enrollment_type", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"published", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"completed", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"by_teachers", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"by_subaccounts", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"hide_enrollmentless_courses", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["created", "claimed", "available", "completed", "deleted", "all"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_term_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["syllabus_body", "term", "course_progress", "storage_quota_used_mb", "total_students", "teachers"], "items"=>{"type"=>"string"}}] },
|
|
19
|
-
"UPDATE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[default_time_zone]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
19
|
+
"UPDATE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[default_time_zone]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][value]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][locked]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[services]", "type"=>"Hash", "format"=>nil, "required"=>false}] },
|
|
20
20
|
"DELETE_USER_FROM_ROOT_ACCOUNT" => { uri: ->(account_id:, user_id:) { "accounts/#{account_id}/users/#{user_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
21
21
|
"CREATE_NEW_SUB_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/sub_accounts" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"account[sis_account_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}] },
|
|
22
22
|
"MAKE_ACCOUNT_ADMIN" => { uri: ->(account_id:) { "accounts/#{account_id}/admins" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>true}, {"paramType"=>"form", "name"=>"role", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"role_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"send_confirmation", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
@@ -43,10 +43,10 @@ module LMS
|
|
|
43
43
|
"CREATE_EXTERNAL_FEED_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/external_feeds" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"header_match", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"verbosity", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["full", "truncate", "link_only"]}] },
|
|
44
44
|
"DELETE_EXTERNAL_FEED_COURSES" => { uri: ->(course_id:, external_feed_id:) { "courses/#{course_id}/external_feeds/#{external_feed_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_feed_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
45
45
|
"DELETE_EXTERNAL_FEED_GROUPS" => { uri: ->(group_id:, external_feed_id:) { "groups/#{group_id}/external_feeds/#{external_feed_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_feed_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
46
|
-
"LIST_ANNOUNCEMENTS" => { uri: ->() { "announcements" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false}] },
|
|
47
|
-
"LIST_APPOINTMENT_GROUPS" => { uri: ->() { "appointment_groups" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["reservable", "manageable"]}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include_past_appointments", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["appointments", "child_events", "participant_count", "reserved_times"], "items"=>{"type"=>"string"}}] },
|
|
46
|
+
"LIST_ANNOUNCEMENTS" => { uri: ->() { "announcements" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"active_only", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
47
|
+
"LIST_APPOINTMENT_GROUPS" => { uri: ->() { "appointment_groups" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["reservable", "manageable"]}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include_past_appointments", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["appointments", "child_events", "participant_count", "reserved_times", "all_context_codes"], "items"=>{"type"=>"string"}}] },
|
|
48
48
|
"CREATE_APPOINTMENT_GROUP" => { uri: ->() { "appointment_groups" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"appointment_group[context_codes]", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[sub_context_codes]", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[title]", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"appointment_group[description]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[location_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[location_address]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[publish]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[participants_per_appointment]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[min_appointments_per_participant]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[max_appointments_per_participant]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[new_appointments][X]", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[participant_visibility]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["private", "protected"]}] },
|
|
49
|
-
"GET_SINGLE_APPOINTMENT_GROUP" => { uri: ->(id:) { "appointment_groups/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["child_events", "appointments"], "items"=>{"type"=>"string"}}] },
|
|
49
|
+
"GET_SINGLE_APPOINTMENT_GROUP" => { uri: ->(id:) { "appointment_groups/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["child_events", "appointments", "all_context_codes"], "items"=>{"type"=>"string"}}] },
|
|
50
50
|
"UPDATE_APPOINTMENT_GROUP" => { uri: ->(id:) { "appointment_groups/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"appointment_group[context_codes]", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[sub_context_codes]", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[title]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[description]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[location_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[location_address]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[publish]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[participants_per_appointment]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[min_appointments_per_participant]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[max_appointments_per_participant]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"appointment_group[new_appointments][X]", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[participant_visibility]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["private", "protected"]}] },
|
|
51
51
|
"DELETE_APPOINTMENT_GROUP" => { uri: ->(id:) { "appointment_groups/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"cancel_reason", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
52
52
|
"LIST_USER_PARTICIPANTS" => { uri: ->(id:) { "appointment_groups/#{id}/users" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"registration_status", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["all", "registered", "registered"]}] },
|
|
@@ -54,7 +54,7 @@ module LMS
|
|
|
54
54
|
"GET_NEXT_APPOINTMENT" => { uri: ->() { "appointment_groups/next_appointment" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"appointment_group_ids", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
55
55
|
"LIST_ASSIGNMENT_GROUPS" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["assignments", "discussion_topic", "all_dates", "assignment_visibility", "overrides", "submission"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_assignment_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["online_quiz", "discussion_topic", "wiki_page", "external_tool"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"scope_assignments_to_student", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
56
56
|
"GET_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["assignments", "discussion_topic", "assignment_visibility", "submission"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false}] },
|
|
57
|
-
"CREATE_ASSIGNMENT_GROUP" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"position", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"group_weight", "type"=>"Float", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"rules", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
57
|
+
"CREATE_ASSIGNMENT_GROUP" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"position", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"group_weight", "type"=>"Float", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"sis_source_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"integration_data", "type"=>"Object", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"rules", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
58
58
|
"EDIT_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
59
59
|
"DESTROY_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"move_assignments_to", "type"=>"integer", "format"=>"int64", "required"=>false}] },
|
|
60
60
|
"DELETE_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
@@ -103,6 +103,8 @@ module LMS
|
|
|
103
103
|
"LIST_COLLABORATIONS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/collaborations" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
104
104
|
"LIST_COLLABORATIONS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/collaborations" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
105
105
|
"LIST_MEMBERS_OF_COLLABORATION" => { uri: ->(id:) { "collaborations/#{id}/members" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["collaborator_lti_id", "avatar_image_url"], "items"=>{"type"=>"string"}}] },
|
|
106
|
+
"LIST_POTENTIAL_MEMBERS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/potential_collaborators" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
107
|
+
"LIST_POTENTIAL_MEMBERS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/potential_collaborators" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
106
108
|
"LIST_OF_COMMMESSAGES_FOR_USER" => { uri: ->() { "comm_messages" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false}] },
|
|
107
109
|
"LIST_USER_COMMUNICATION_CHANNELS" => { uri: ->(user_id:) { "users/#{user_id}/communication_channels" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
108
110
|
"CREATE_COMMUNICATION_CHANNEL" => { uri: ->(user_id:) { "users/#{user_id}/communication_channels" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"communication_channel[address]", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"communication_channel[type]", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["email", "sms", "push"]}, {"paramType"=>"form", "name"=>"communication_channel[token]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"skip_confirmation", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
@@ -155,7 +157,7 @@ module LMS
|
|
|
155
157
|
"CREATE_CONVERSATION" => { uri: ->() { "conversations" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"recipients", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"subject", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"body", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"group_conversation", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"attachment_ids", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"media_comment_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"media_comment_type", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"user_note", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"mode", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["sync", "async"]}, {"paramType"=>"form", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["unread", "starred", "archived"]}, {"paramType"=>"form", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"filter_mode", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["and", "or", "default or"]}, {"paramType"=>"form", "name"=>"context_code", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
156
158
|
"GET_RUNNING_BATCHES" => { uri: ->() { "conversations/batches" }, method: "GET", parameters: [] },
|
|
157
159
|
"GET_SINGLE_CONVERSATION" => { uri: ->(id:) { "conversations/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"interleave_submissions", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["unread", "starred", "archived"]}, {"paramType"=>"query", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter_mode", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["and", "or", "default or"]}, {"paramType"=>"query", "name"=>"auto_mark_as_read", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
158
|
-
"EDIT_CONVERSATION" => { uri: ->(id:) { "conversations/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"conversation[
|
|
160
|
+
"EDIT_CONVERSATION" => { uri: ->(id:) { "conversations/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"conversation[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["read", "unread", "archived"]}, {"paramType"=>"form", "name"=>"conversation[subscribed]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"conversation[starred]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["unread", "starred", "archived"]}, {"paramType"=>"form", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"filter_mode", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["and", "or", "default or"]}] },
|
|
159
161
|
"MARK_ALL_AS_READ" => { uri: ->() { "conversations/mark_all_as_read" }, method: "POST", parameters: [] },
|
|
160
162
|
"DELETE_CONVERSATION" => { uri: ->(id:) { "conversations/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
161
163
|
"ADD_RECIPIENTS" => { uri: ->(id:) { "conversations/#{id}/add_recipients" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"recipients", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}] },
|
|
@@ -166,8 +168,8 @@ module LMS
|
|
|
166
168
|
"UNREAD_COUNT" => { uri: ->() { "conversations/unread_count" }, method: "GET", parameters: [] },
|
|
167
169
|
"COURSE_AUDIT_LOG_QUERY_BY_COURSE" => { uri: ->(course_id:) { "audit/course/courses/#{course_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false}] },
|
|
168
170
|
"COURSE_QUIZ_EXTENSIONS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONS" => { uri: ->(course_id:) { "courses/#{course_id}/quiz_extensions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>true}, {"paramType"=>"form", "name"=>"extra_attempts", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"extra_time", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"manually_unlocked", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"extend_from_now", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"extend_from_end_at", "type"=>"integer", "format"=>"int64", "required"=>false}] },
|
|
169
|
-
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
|
170
|
-
"LIST_COURSES_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["active", "invited_or_pending", "completed"]}] },
|
|
171
|
+
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
|
172
|
+
"LIST_COURSES_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["active", "invited_or_pending", "completed"]}] },
|
|
171
173
|
"CREATE_NEW_COURSE" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enroll_me", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enable_sis_reactivation", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
172
174
|
"COURSES_UPLOAD_FILE" => { uri: ->(course_id:) { "courses/#{course_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
173
175
|
"LIST_STUDENTS" => { uri: ->(course_id:) { "courses/#{course_id}/students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
@@ -181,12 +183,14 @@ module LMS
|
|
|
181
183
|
"COURSE_TODO_ITEMS" => { uri: ->(course_id:) { "courses/#{course_id}/todo" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
182
184
|
"CONCLUDE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"event", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["delete", "conclude"]}] },
|
|
183
185
|
"GET_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
184
|
-
"UPDATE_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"allow_student_discussion_topics", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"allow_student_forum_attachments", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_editing", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"allow_student_organized_groups", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"hide_final_grades", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"hide_distribution_graphs", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"lock_all_announcements", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"restrict_student_past_view", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"restrict_student_future_view", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
185
|
-
"GET_SINGLE_COURSE_COURSES" => { uri: ->(id:) { "courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users"], "items"=>{"type"=>"string"}}] },
|
|
186
|
-
"GET_SINGLE_COURSE_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users"], "items"=>{"type"=>"string"}}] },
|
|
186
|
+
"UPDATE_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"allow_student_discussion_topics", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"allow_student_forum_attachments", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_editing", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"allow_student_organized_groups", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"hide_final_grades", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"hide_distribution_graphs", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"lock_all_announcements", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"restrict_student_past_view", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"restrict_student_future_view", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"show_announcements_on_home_page", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"home_page_announcement_limit", "type"=>"integer", "format"=>"int64", "required"=>false}] },
|
|
187
|
+
"GET_SINGLE_COURSE_COURSES" => { uri: ->(id:) { "courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users", "course_image"], "items"=>{"type"=>"string"}}] },
|
|
188
|
+
"GET_SINGLE_COURSE_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users", "course_image"], "items"=>{"type"=>"string"}}] },
|
|
187
189
|
"UPDATE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"course[account_id]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[event]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["claim", "offer", "conclude", "delete", "undelete"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[image_id]", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"form", "name"=>"course[image_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course[remove_image]", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
188
190
|
"UPDATE_COURSES" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"course_ids", "type"=>"array", "format"=>nil, "required"=>true, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"event", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["offer", "conclude", "delete", "undelete"]}] },
|
|
189
191
|
"RESET_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/reset_content" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
192
|
+
"GET_EFFECTIVE_DUE_DATES" => { uri: ->(course_id:) { "courses/#{course_id}/effective_due_dates" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
193
|
+
"PERMISSIONS" => { uri: ->(course_id:) { "courses/#{course_id}/permissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"permissions", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
190
194
|
"GET_COURSE_COPY_STATUS" => { uri: ->(course_id:, id:) { "courses/#{course_id}/course_copy/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
191
195
|
"COPY_COURSE_CONTENT" => { uri: ->(course_id:) { "courses/#{course_id}/course_copy" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"source_course", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"except", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["course_settings", "assignments", "external_tools", "files", "topics", "calendar_events", "quizzes", "wiki_pages", "modules", "outcomes"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["course_settings", "assignments", "external_tools", "files", "topics", "calendar_events", "quizzes", "wiki_pages", "modules", "outcomes"], "items"=>{"type"=>"string"}}] },
|
|
192
196
|
"LIST_CUSTOM_GRADEBOOK_COLUMNS" => { uri: ->(course_id:) { "courses/#{course_id}/custom_gradebook_columns" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"include_hidden", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
@@ -242,10 +246,10 @@ module LMS
|
|
|
242
246
|
"SUBSCRIBE_TO_TOPIC_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/subscribed" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
243
247
|
"UNSUBSCRIBE_FROM_TOPIC_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/subscribed" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
244
248
|
"UNSUBSCRIBE_FROM_TOPIC_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/subscribed" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
245
|
-
"CREATE_ENROLLMENT_TERM" => { uri: ->(account_id:) { "accounts/#{account_id}/terms" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"enrollment_term[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[sis_term_id]", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
246
|
-
"UPDATE_ENROLLMENT_TERM" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/terms/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}
|
|
249
|
+
"CREATE_ENROLLMENT_TERM" => { uri: ->(account_id:) { "accounts/#{account_id}/terms" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"enrollment_term[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[sis_term_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[overrides][enrollment_type][start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[overrides][enrollment_type][end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false}] },
|
|
250
|
+
"UPDATE_ENROLLMENT_TERM" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/terms/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
247
251
|
"DELETE_ENROLLMENT_TERM" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/terms/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
248
|
-
"LIST_ENROLLMENT_TERMS" => { uri: ->(account_id:) { "accounts/#{account_id}/terms" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["active", "deleted", "all"], "items"=>{"type"=>"string"}}] },
|
|
252
|
+
"LIST_ENROLLMENT_TERMS" => { uri: ->(account_id:) { "accounts/#{account_id}/terms" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["active", "deleted", "all"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["overrides"], "items"=>{"type"=>"string"}}] },
|
|
249
253
|
"LIST_ENROLLMENTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/enrollments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"type", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"role", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["active", "invited", "creation_pending", "deleted", "rejected", "completed", "inactive"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["avatar_url", "group_ids", "locked", "observed_users", "can_be_removed"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"sis_account_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_course_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_section_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_user_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
250
254
|
"LIST_ENROLLMENTS_SECTIONS" => { uri: ->(section_id:) { "sections/#{section_id}/enrollments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"type", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"role", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["active", "invited", "creation_pending", "deleted", "rejected", "completed", "inactive"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["avatar_url", "group_ids", "locked", "observed_users", "can_be_removed"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"sis_account_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_course_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_section_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_user_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
251
255
|
"LIST_ENROLLMENTS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/enrollments" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"type", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"role", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["active", "invited", "creation_pending", "deleted", "rejected", "completed", "inactive"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "enum"=>["avatar_url", "group_ids", "locked", "observed_users", "can_be_removed"], "items"=>{"type"=>"string"}}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"sis_account_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_course_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_section_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_user_id", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
@@ -255,15 +259,15 @@ module LMS
|
|
|
255
259
|
"CONCLUDE_DEACTIVATE_OR_DELETE_ENROLLMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/enrollments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"task", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["conclude", "delete", "inactivate", "deactivate"]}] },
|
|
256
260
|
"RE_ACTIVATE_ENROLLMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/enrollments/#{id}/reactivate" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
257
261
|
"CREATE_ERROR_REPORT" => { uri: ->() { "error_reports" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"error[subject]", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"error[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"error[email]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"error[comments]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"error[http_env]", "type"=>"SerializedHash", "format"=>nil, "required"=>false}] },
|
|
258
|
-
"LIST_EXTERNAL_TOOLS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
259
|
-
"LIST_EXTERNAL_TOOLS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/external_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
260
|
-
"LIST_EXTERNAL_TOOLS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/external_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
262
|
+
"LIST_EXTERNAL_TOOLS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"include_parents", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
263
|
+
"LIST_EXTERNAL_TOOLS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/external_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"include_parents", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
264
|
+
"LIST_EXTERNAL_TOOLS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/external_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"include_parents", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
261
265
|
"GET_SESSIONLESS_LAUNCH_URL_FOR_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools/sessionless_launch" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"module_item_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"launch_type", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["assessment", "module_item"]}] },
|
|
262
266
|
"GET_SESSIONLESS_LAUNCH_URL_FOR_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/external_tools/sessionless_launch" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"module_item_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"launch_type", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["assessment", "module_item"]}] },
|
|
263
267
|
"GET_SINGLE_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:, external_tool_id:) { "courses/#{course_id}/external_tools/#{external_tool_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
264
268
|
"GET_SINGLE_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:, external_tool_id:) { "accounts/#{account_id}/external_tools/#{external_tool_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
265
|
-
"CREATE_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
266
|
-
"CREATE_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/external_tools" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
269
|
+
"CREATE_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
270
|
+
"CREATE_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/external_tools" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
267
271
|
"EDIT_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:, external_tool_id:) { "courses/#{course_id}/external_tools/#{external_tool_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
268
272
|
"EDIT_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:, external_tool_id:) { "accounts/#{account_id}/external_tools/#{external_tool_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
269
273
|
"DELETE_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:, external_tool_id:) { "courses/#{course_id}/external_tools/#{external_tool_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
@@ -574,6 +578,8 @@ module LMS
|
|
|
574
578
|
"GET_SIS_IMPORT_LIST" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_imports" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"created_since", "type"=>"DateTime", "format"=>nil, "required"=>false}] },
|
|
575
579
|
"IMPORT_SIS_DATA" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_imports" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"import_type", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"extension", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"batch_mode_term_id", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"override_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"add_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"clear_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"diffing_data_set_identifier", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"diffing_remaster_data_set", "type"=>"boolean", "format"=>nil, "required"=>false}] },
|
|
576
580
|
"GET_SIS_IMPORT_STATUS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sis_imports/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
581
|
+
"ABORT_SIS_IMPORT" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sis_imports/#{id}/abort" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
582
|
+
"ABORT_ALL_PENDING_SIS_IMPORTS" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_imports/abort_all_pending" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
577
583
|
"RETRIEVE_ASSIGNMENTS_ENABLED_FOR_GRADE_EXPORT_TO_SIS_ACCOUNTS" => { uri: ->(account_id:) { "/sis/accounts/#{account_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"integer", "format"=>"int64", "required"=>true}, {"paramType"=>"query", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"DateTime", "format"=>nil, "required"=>false}] },
|
|
578
584
|
"RETRIEVE_ASSIGNMENTS_ENABLED_FOR_GRADE_EXPORT_TO_SIS_COURSES" => { uri: ->(course_id:) { "/sis/courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"account_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"DateTime", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"DateTime", "format"=>nil, "required"=>false}] },
|
|
579
585
|
"FIND_RECIPIENTS_CONVERSATIONS" => { uri: ->() { "conversations/find_recipients" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"search", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"context", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["user", "context"]}, {"paramType"=>"query", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"from_conversation_id", "type"=>"integer", "format"=>"int64", "required"=>false}, {"paramType"=>"query", "name"=>"permissions", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
@@ -606,6 +612,7 @@ module LMS
|
|
|
606
612
|
"GRADE_OR_COMMENT_ON_SUBMISSION_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"comment[group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"comment[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"include[visibility]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"submission[posted_grade]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"submission[excuse]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"RubricAssessment", "format"=>nil, "required"=>false}] },
|
|
607
613
|
"GRADE_OR_COMMENT_ON_SUBMISSION_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"comment[group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"comment[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"include[visibility]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"submission[posted_grade]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"submission[excuse]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"RubricAssessment", "format"=>nil, "required"=>false}] },
|
|
608
614
|
"LIST_GRADEABLE_STUDENTS" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/gradeable_students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
615
|
+
"LIST_MULTIPLE_ASSIGNMENTS_GRADEABLE_STUDENTS" => { uri: ->(course_id:) { "courses/#{course_id}/assignments/gradeable_students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "items"=>{"type"=>"string"}}] },
|
|
609
616
|
"GRADE_OR_COMMENT_ON_MULTIPLE_SUBMISSIONS_COURSES_SUBMISSIONS" => { uri: ->(course_id:) { "courses/#{course_id}/submissions/update_grades" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}] },
|
|
610
617
|
"GRADE_OR_COMMENT_ON_MULTIPLE_SUBMISSIONS_COURSES_ASSIGNMENTS" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/update_grades" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}] },
|
|
611
618
|
"GRADE_OR_COMMENT_ON_MULTIPLE_SUBMISSIONS_SECTIONS_SUBMISSIONS" => { uri: ->(section_id:) { "sections/#{section_id}/submissions/update_grades" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "items"=>{"type"=>"integer"}}] },
|
|
@@ -639,6 +646,8 @@ module LMS
|
|
|
639
646
|
"GET_CUSTOM_COLORS" => { uri: ->(id:) { "users/#{id}/colors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
640
647
|
"GET_CUSTOM_COLOR" => { uri: ->(id:, asset_string:) { "users/#{id}/colors/#{asset_string}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"asset_string", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
641
648
|
"UPDATE_CUSTOM_COLOR" => { uri: ->(id:, asset_string:) { "users/#{id}/colors/#{asset_string}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"asset_string", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"hexcode", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
649
|
+
"GET_DASHBOARD_POSTIONS" => { uri: ->(id:) { "users/#{id}/dashboard_positions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
650
|
+
"UPDATE_DASHBOARD_POSITIONS" => { uri: ->(id:) { "users/#{id}/dashboard_positions" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
642
651
|
"EDIT_USER" => { uri: ->(id:) { "users/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[email]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[avatar][token]", "type"=>"string", "format"=>nil, "required"=>false}, {"paramType"=>"form", "name"=>"user[avatar][url]", "type"=>"string", "format"=>nil, "required"=>false}] },
|
|
643
652
|
"MERGE_USER_INTO_ANOTHER_USER_DESTINATION_USER_ID" => { uri: ->(id:, destination_user_id:) { "users/#{id}/merge_into/#{destination_user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"destination_user_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
644
653
|
"MERGE_USER_INTO_ANOTHER_USER_ACCOUNTS" => { uri: ->(id:, destination_account_id:, destination_user_id:) { "users/#{id}/merge_into/accounts/#{destination_account_id}/users/#{destination_user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"destination_account_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"destination_user_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
@@ -654,6 +663,8 @@ module LMS
|
|
|
654
663
|
"SET_COURSE_NICKNAME" => { uri: ->(course_id:) { "users/self/course_nicknames/#{course_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"form", "name"=>"nickname", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
655
664
|
"REMOVE_COURSE_NICKNAME" => { uri: ->(course_id:) { "users/self/course_nicknames/#{course_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
656
665
|
"CLEAR_COURSE_NICKNAMES" => { uri: ->() { "users/self/course_nicknames" }, method: "DELETE", parameters: [] },
|
|
666
|
+
"LIST_COURSES_WITH_THEIR_LATEST_EPUB_EXPORT" => { uri: ->() { "epub_exports" }, method: "GET", parameters: [] },
|
|
667
|
+
"CREATE_EPUB_EXPORT" => { uri: ->(course_id:) { "courses/#{course_id}/epub_exports" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}] },
|
|
657
668
|
"SHOW_EPUB_EXPORT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/epub_exports/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true}] }
|
|
658
669
|
}
|
|
659
670
|
end
|
data/lib/lms/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lms-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.2.
|
|
4
|
+
version: 1.2.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Atomic Jolt
|
|
@@ -10,7 +10,7 @@ authors:
|
|
|
10
10
|
autorequire:
|
|
11
11
|
bindir: bin
|
|
12
12
|
cert_chain: []
|
|
13
|
-
date: 2017-
|
|
13
|
+
date: 2017-02-23 00:00:00.000000000 Z
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|
|
16
16
|
name: activesupport
|