lms-api 1.19.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/canvas_api/builder.rb +76 -44
- data/lib/canvas_api/go_helpers.rb +604 -0
- data/lib/canvas_api/helpers.rb +17 -0
- data/lib/canvas_api/js_graphql_helpers.rb +8 -1
- data/lib/canvas_api/rb_graphql_helpers.rb +10 -24
- data/lib/canvas_api/render.rb +13 -2
- data/lib/canvas_api/templates/go_action.erb +241 -0
- data/lib/canvas_api/templates/go_struct.erb +44 -0
- data/lib/canvas_api/templates/rb_graphql_field.erb +2 -2
- data/lib/canvas_api/templates/rb_graphql_input_type.erb +1 -1
- data/lib/canvas_api/templates/rb_graphql_resolver.erb +1 -1
- data/lib/canvas_api/templates/rb_graphql_type.erb +1 -1
- data/lib/lms/canvas_urls.rb +93 -56
- data/lib/lms/course_ids_required.rb +17 -5
- data/lib/lms/version.rb +1 -1
- data/lib/tasks/canvas_api.rake +5 -1
- metadata +10 -6
data/lib/lms/canvas_urls.rb
CHANGED
@@ -1,6 +1,5 @@
|
|
1
1
|
module LMS
|
2
2
|
CANVAS_URLs = {
|
3
|
-
"LIST_SCOPES" => { uri: ->(account_id:) { "accounts/#{account_id}/scopes" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"group_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["resource_name"]}] },
|
4
3
|
"SEARCH_ACCOUNT_DOMAINS" => { uri: ->() { "accounts/search" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"latitude", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"longitude", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}] },
|
5
4
|
"INDEX_OF_ACTIVE_GLOBAL_NOTIFICATION_FOR_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/account_notifications" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include_past", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
6
5
|
"SHOW_GLOBAL_NOTIFICATION" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/account_notifications/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -13,14 +12,17 @@ module LMS
|
|
13
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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"report", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
14
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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"report", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
15
14
|
"LIST_ACCOUNTS" => { uri: ->() { "accounts" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["lti_guid", "registration_settings", "services"], "items"=>{"type"=>"string"}}] },
|
15
|
+
"GET_ACCOUNTS_THAT_ADMINS_CAN_MANAGE" => { uri: ->() { "manageable_accounts" }, method: "GET", parameters: [] },
|
16
16
|
"LIST_ACCOUNTS_FOR_COURSE_ADMINS" => { uri: ->() { "course_accounts" }, method: "GET", parameters: [] },
|
17
17
|
"GET_SINGLE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
18
|
+
"SETTINGS" => { uri: ->(account_id:) { "accounts/#{account_id}/settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
18
19
|
"PERMISSIONS" => { uri: ->(account_id:) { "accounts/#{account_id}/permissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"permissions", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
19
20
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"recursive", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
20
21
|
"GET_TERMS_OF_SERVICE" => { uri: ->(account_id:) { "accounts/#{account_id}/terms_of_service" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
21
22
|
"GET_HELP_LINKS" => { uri: ->(account_id:) { "accounts/#{account_id}/help_links" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
22
|
-
"
|
23
|
-
"
|
23
|
+
"GET_MANUALLY_CREATED_COURSES_SUB_ACCOUNT_FOR_DOMAIN_ROOT_ACCOUNT" => { uri: ->() { "manually_created_courses_account" }, method: "GET", parameters: [] },
|
24
|
+
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"with_enrollments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_type", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"published", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"completed", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"blueprint", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"blueprint_associated", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"by_teachers", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"by_subaccounts", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"hide_enrollmentless_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["created", "claimed", "available", "completed", "deleted", "all"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_term_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["syllabus_body", "term", "course_progress", "storage_quota_used_mb", "total_students", "teachers", "account_name", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course_name", "sis_course_id", "teacher", "account_name"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"search_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course", "teacher"]}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"homeroom", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
25
|
+
"UPDATE_ACCOUNT" => { uri: ->(id:) { "accounts/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[sis_account_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[course_template_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_past_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][microsoft_sync_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][microsoft_sync_tenant]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][microsoft_sync_login_attribute]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][microsoft_sync_login_attribute_suffix]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][microsoft_sync_remote_attribute]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_view][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_all_announcements][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][usage_rights_required][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][usage_rights_required][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][restrict_student_future_listing][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_outcome_proficiency][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[lock_outcome_proficiency][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[settings][lock_proficiency_calculation][value]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[lock_proficiency_calculation][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[services]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
24
26
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
25
27
|
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[sis_account_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_user_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account[default_group_storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
26
28
|
"DELETE_SUB_ACCOUNT" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sub_accounts/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -37,6 +39,9 @@ module LMS
|
|
37
39
|
"GET_DEPARTMENT_LEVEL_STATISTICS_TERMS" => { uri: ->(account_id:, term_id:) { "accounts/#{account_id}/analytics/terms/#{term_id}/statistics" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"term_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
38
40
|
"GET_DEPARTMENT_LEVEL_STATISTICS_CURRENT" => { uri: ->(account_id:) { "accounts/#{account_id}/analytics/current/statistics" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
39
41
|
"GET_DEPARTMENT_LEVEL_STATISTICS_COMPLETED" => { uri: ->(account_id:) { "accounts/#{account_id}/analytics/completed/statistics" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
42
|
+
"GET_DEPARTMENT_LEVEL_STATISTICS_BROKEN_DOWN_BY_SUBACCOUNT_TERMS" => { uri: ->(account_id:, term_id:) { "accounts/#{account_id}/analytics/terms/#{term_id}/statistics_by_subaccount" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"term_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
43
|
+
"GET_DEPARTMENT_LEVEL_STATISTICS_BROKEN_DOWN_BY_SUBACCOUNT_CURRENT" => { uri: ->(account_id:) { "accounts/#{account_id}/analytics/current/statistics_by_subaccount" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
44
|
+
"GET_DEPARTMENT_LEVEL_STATISTICS_BROKEN_DOWN_BY_SUBACCOUNT_COMPLETED" => { uri: ->(account_id:) { "accounts/#{account_id}/analytics/completed/statistics_by_subaccount" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
40
45
|
"GET_COURSE_LEVEL_PARTICIPATION_DATA" => { uri: ->(course_id:) { "courses/#{course_id}/analytics/activity" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
41
46
|
"GET_COURSE_LEVEL_ASSIGNMENT_DATA" => { uri: ->(course_id:) { "courses/#{course_id}/analytics/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"async", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
42
47
|
"GET_COURSE_LEVEL_STUDENT_SUMMARY_DATA" => { uri: ->(course_id:) { "courses/#{course_id}/analytics/student_summaries" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sort_column", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "name_descending", "score", "score_descending", "participations", "participations_descending", "page_views", "page_views_descending"]}, {"paramType"=>"query", "name"=>"student_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -49,7 +54,8 @@ module LMS
|
|
49
54
|
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"header_match", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"verbosity", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["full", "truncate", "link_only"]}] },
|
50
55
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_feed_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
51
56
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_feed_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
52
|
-
"LIST_ANNOUNCEMENTS" => { uri: ->() { "announcements" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"active_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
57
|
+
"LIST_ANNOUNCEMENTS" => { uri: ->() { "announcements" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"active_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"latest_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
58
|
+
"LIST_SCOPES" => { uri: ->(account_id:) { "accounts/#{account_id}/scopes" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"group_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["resource_name"]}] },
|
53
59
|
"LIST_APPOINTMENT_GROUPS" => { uri: ->() { "appointment_groups" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["reservable", "manageable"]}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include_past_appointments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["appointments", "child_events", "participant_count", "reserved_times", "all_context_codes"], "items"=>{"type"=>"string"}}] },
|
54
60
|
"CREATE_APPOINTMENT_GROUP" => { uri: ->() { "appointment_groups" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"appointment_group[context_codes]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[sub_context_codes]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[title]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[location_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[location_address]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[publish]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[participants_per_appointment]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[min_appointments_per_participant]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[max_appointments_per_participant]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"appointment_group[new_appointments][X]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"appointment_group[participant_visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["private", "protected"]}] },
|
55
61
|
"GET_SINGLE_APPOINTMENT_GROUP" => { uri: ->(id:) { "appointment_groups/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["child_events", "appointments", "all_context_codes"], "items"=>{"type"=>"string"}}] },
|
@@ -68,9 +74,10 @@ module LMS
|
|
68
74
|
"LIST_ASSIGNMENTS_ASSIGNMENTS" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
69
75
|
"LIST_ASSIGNMENTS_ASSIGNMENT_GROUPS" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
70
76
|
"LIST_ASSIGNMENTS_FOR_USER" => { uri: ->(user_id:, course_id:) { "users/#{user_id}/courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
77
|
+
"DUPLICATE_ASSIGNNMENT" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/duplicate" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"result_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["Quiz"]}] },
|
71
78
|
"GET_SINGLE_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "overrides", "observed_users", "can_edit", "score_statistics"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
72
|
-
"CREATE_ASSIGNMENT" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[quiz_lti]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
73
|
-
"EDIT_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[sis_assignment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
79
|
+
"CREATE_ASSIGNMENT" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording", "student_annotation"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[quiz_lti]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
80
|
+
"EDIT_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording", "student_annotation"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[sis_assignment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
74
81
|
"BULK_UPDATE_ASSIGNMENT_DATES" => { uri: ->(course_id:) { "courses/#{course_id}/assignments/bulk_update" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
75
82
|
"LIST_ASSIGNMENT_OVERRIDES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
76
83
|
"GET_SINGLE_ASSIGNMENT_OVERRIDE" => { uri: ->(course_id:, assignment_id:, id:) { "courses/#{course_id}/assignments/#{assignment_id}/overrides/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -96,7 +103,7 @@ module LMS
|
|
96
103
|
"GET_ASSOCIATED_COURSE_INFORMATION" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/associated_courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
97
104
|
"UPDATE_ASSOCIATED_COURSES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/update_associations" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_ids_to_add", "type"=>"Array", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_ids_to_remove", "type"=>"Array", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
98
105
|
"BEGIN_MIGRATION_TO_PUSH_TO_ASSOCIATED_COURSES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"send_notification", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"copy_settings", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"publish_after_initial_sync", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
99
|
-
"SET_OR_REMOVE_RESTRICTIONS_ON_BLUEPRINT_COURSE_OBJECT" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/restrict_item" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"content_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false
|
106
|
+
"SET_OR_REMOVE_RESTRICTIONS_ON_BLUEPRINT_COURSE_OBJECT" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/restrict_item" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"content_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"content_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restricted", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrictions", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
100
107
|
"GET_UNSYNCED_CHANGES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/unsynced_changes" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
101
108
|
"LIST_BLUEPRINT_MIGRATIONS" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/migrations" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
102
109
|
"SHOW_BLUEPRINT_MIGRATION" => { uri: ->(course_id:, template_id:, id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/migrations/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -111,8 +118,8 @@ module LMS
|
|
111
118
|
"UPDATE_BOOKMARK" => { uri: ->(id:) { "users/self/bookmarks/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"position", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"data", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
112
119
|
"DELETE_BOOKMARK" => { uri: ->(id:) { "users/self/bookmarks/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
113
120
|
"GET_BRAND_CONFIG_VARIABLES_THAT_SHOULD_BE_USED_FOR_THIS_DOMAIN" => { uri: ->() { "brand_variables" }, method: "GET", parameters: [] },
|
114
|
-
"LIST_CALENDAR_EVENTS" => { uri: ->() { "calendar_events" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["event", "assignment"]}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"undated", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_events", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"excludes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}] },
|
115
|
-
"LIST_CALENDAR_EVENTS_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/calendar_events" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["event", "assignment"]}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"undated", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_events", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"excludes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"exclude_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}] },
|
121
|
+
"LIST_CALENDAR_EVENTS" => { uri: ->() { "calendar_events" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["event", "assignment"]}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"undated", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_events", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"excludes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"important_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
122
|
+
"LIST_CALENDAR_EVENTS_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/calendar_events" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["event", "assignment"]}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"undated", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_events", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"excludes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"exclude_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"important_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
116
123
|
"CREATE_CALENDAR_EVENT" => { uri: ->() { "calendar_events" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"calendar_event[context_code]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[location_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[location_address]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[time_zone_edited]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[all_day]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[child_event_data][X][start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[child_event_data][X][end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[child_event_data][X][context_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[duplicate][count]", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[duplicate][interval]", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"calendar_event[duplicate][frequency]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["daily", "weekly", "monthly"]}, {"paramType"=>"form", "name"=>"calendar_event[duplicate][append_iterator]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
117
124
|
"GET_SINGLE_CALENDAR_EVENT_OR_ASSIGNMENT" => { uri: ->(id:) { "calendar_events/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
118
125
|
"RESERVE_TIME_SLOT" => { uri: ->(id:) { "calendar_events/#{id}/reservations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"participant_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comments", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"cancel_existing", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -214,9 +221,10 @@ module LMS
|
|
214
221
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
215
222
|
"COURSE_AUDIT_LOG_QUERY_BY_ACCOUNT" => { uri: ->(account_id:) { "audit/course/accounts/#{account_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
216
223
|
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extra_attempts", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extra_time", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"manually_unlocked", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extend_from_now", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extend_from_end_at", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
217
|
-
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
218
|
-
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}] },
|
219
|
-
"
|
224
|
+
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "grading_periods", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
225
|
+
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "grading_periods", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"homeroom", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
226
|
+
"GET_USER_PROGRESS" => { uri: ->(course_id:, user_id:) { "courses/#{course_id}/users/#{user_id}/progress" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
227
|
+
"CREATE_NEW_COURSE" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enroll_me", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enable_sis_reactivation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
220
228
|
"COURSES_UPLOAD_FILE" => { uri: ->(course_id:) { "courses/#{course_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
221
229
|
"LIST_STUDENTS" => { uri: ->(course_id:) { "courses/#{course_id}/students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
222
230
|
"LIST_USERS_IN_COURSE_USERS" => { uri: ->(course_id:) { "courses/#{course_id}/users" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["username", "last_login", "email", "sis_id"]}, {"paramType"=>"query", "name"=>"enrollment_type", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "student_view", "ta", "observer", "designer"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["enrollments", "locked", "avatar_url", "test_student", "bio", "custom_links", "current_grading_period_scores", "uuid"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"user_ids", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited", "rejected", "completed", "inactive"], "items"=>{"type"=>"string"}}] },
|
@@ -230,15 +238,16 @@ module LMS
|
|
230
238
|
"COURSE_TODO_ITEMS" => { uri: ->(course_id:) { "courses/#{course_id}/todo" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
231
239
|
"DELETE_CONCLUDE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"event", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["delete", "conclude"]}] },
|
232
240
|
"GET_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
233
|
-
"UPDATE_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_topics", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_forum_attachments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_editing", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_organized_groups", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"filter_speed_grader_by_student_group", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_final_grades", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_distribution_graphs", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_sections_on_course_users_page", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"lock_all_announcements", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights_required", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrict_student_past_view", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrict_student_future_view", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"show_announcements_on_home_page", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"home_page_announcement_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"syllabus_course_summary", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
241
|
+
"UPDATE_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_topics", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_forum_attachments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_editing", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_organized_groups", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_reporting", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"filter_speed_grader_by_student_group", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_final_grades", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_distribution_graphs", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_sections_on_course_users_page", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"lock_all_announcements", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights_required", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrict_student_past_view", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrict_student_future_view", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"show_announcements_on_home_page", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"home_page_announcement_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"syllabus_course_summary", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
234
242
|
"RETURN_TEST_STUDENT_FOR_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/student_view_student" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
235
243
|
"GET_SINGLE_COURSE_COURSES" => { uri: ->(id:) { "courses/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"teacher_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
236
244
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "all_courses", "permissions", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"teacher_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
237
|
-
"UPDATE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[account_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[event]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["claim", "offer", "conclude", "delete", "undelete"]}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[syllabus_course_summary]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[remove_image]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions]", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[use_blueprint_restrictions_by_object_type]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions_by_object_type]", "type"=>"multiple BlueprintRestrictions", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
245
|
+
"UPDATE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[account_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[event]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["claim", "offer", "conclude", "delete", "undelete"]}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[syllabus_course_summary]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[remove_image]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[remove_banner_image]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions]", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[use_blueprint_restrictions_by_object_type]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions_by_object_type]", "type"=>"multiple BlueprintRestrictions", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[homeroom_course]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sync_enrollments_from_homeroom]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[homeroom_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[template]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_color]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[friendly_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[enable_pace_plans]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
238
246
|
"UPDATE_COURSES" => { uri: ->(account_id:) { "accounts/#{account_id}/courses" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_ids", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"event", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["offer", "conclude", "delete", "undelete"]}] },
|
239
247
|
"RESET_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/reset_content" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
240
248
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
241
249
|
"COURSES_PERMISSIONS" => { uri: ->(course_id:) { "courses/#{course_id}/permissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"permissions", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
250
|
+
"GET_BULK_USER_PROGRESS" => { uri: ->(course_id:) { "courses/#{course_id}/bulk_user_progress" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
242
251
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
243
252
|
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"source_course", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"except", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>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, "deprecated"=>false, "enum"=>["course_settings", "assignments", "external_tools", "files", "topics", "calendar_events", "quizzes", "wiki_pages", "modules", "outcomes"], "items"=>{"type"=>"string"}}] },
|
244
253
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include_hidden", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -269,6 +278,8 @@ module LMS
|
|
269
278
|
"GET_FULL_TOPIC_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/view" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
270
279
|
"POST_ENTRY_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/entries" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"message", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
271
280
|
"POST_ENTRY_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/entries" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"message", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
281
|
+
"DUPLICATE_DISCUSSION_TOPIC_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/duplicate" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
282
|
+
"DUPLICATE_DISCUSSION_TOPIC_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/duplicate" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
272
283
|
"LIST_TOPIC_ENTRIES_COURSES" => { uri: ->(course_id:, topic_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/entries" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
273
284
|
"LIST_TOPIC_ENTRIES_GROUPS" => { uri: ->(group_id:, topic_id:) { "groups/#{group_id}/discussion_topics/#{topic_id}/entries" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
274
285
|
"POST_REPLY_COURSES" => { uri: ->(course_id:, topic_id:, entry_id:) { "courses/#{course_id}/discussion_topics/#{topic_id}/entries/#{entry_id}/replies" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"topic_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"entry_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"message", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -311,6 +322,16 @@ module LMS
|
|
311
322
|
"REJECT_COURSE_INVITATION" => { uri: ->(course_id:, id:) { "courses/#{course_id}/enrollments/#{id}/reject" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
312
323
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
313
324
|
"ADDS_LAST_ATTENDED_DATE_TO_STUDENT_ENROLLMENT_IN_COURSE" => { uri: ->(course_id:, user_id:) { "courses/#{course_id}/users/#{user_id}/last_attended" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
325
|
+
"GET_ALL_EPORTFOLIOS_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/eportfolios" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["deleted"], "items"=>{"type"=>"string"}}] },
|
326
|
+
"GET_EPORTFOLIO" => { uri: ->(id:) { "eportfolios/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
327
|
+
"DELETE_EPORTFOLIO" => { uri: ->(id:) { "eportfolios/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
328
|
+
"GET_EPORTFOLIO_PAGES" => { uri: ->(eportfolio_id:) { "eportfolios/#{eportfolio_id}/pages" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"eportfolio_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
329
|
+
"MODERATE_EPORTFOLIO" => { uri: ->(eportfolio_id:) { "eportfolios/#{eportfolio_id}/moderate" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"eportfolio_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"spam_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["marked_as_spam", "marked_as_safe"]}] },
|
330
|
+
"MODERATE_ALL_EPORTFOLIOS_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/eportfolios" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"spam_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["marked_as_spam", "marked_as_safe"]}] },
|
331
|
+
"RESTORE_DELETED_EPORTFOLIO" => { uri: ->(eportfolio_id:) { "eportfolios/#{eportfolio_id}/restore" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"eportfolio_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
332
|
+
"LIST_COURSES_WITH_THEIR_LATEST_EPUB_EXPORT" => { uri: ->() { "epub_exports" }, method: "GET", parameters: [] },
|
333
|
+
"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, "deprecated"=>false}] },
|
334
|
+
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
314
335
|
"CREATE_ERROR_REPORT" => { uri: ->() { "error_reports" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"error[subject]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"error[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"error[email]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"error[comments]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"error[http_env]", "type"=>"SerializedHash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
315
336
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include_parents", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
316
337
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include_parents", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -319,14 +340,16 @@ module LMS
|
|
319
340
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"module_item_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"launch_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assessment", "module_item"]}] },
|
320
341
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
321
342
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
322
|
-
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"client_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_rce_favorite", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["disabled", "enabled"]}, {"paramType"=>"form", "name"=>"course_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[prefer_sis_email]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
323
|
-
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"client_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_rce_favorite", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["disabled", "enabled"]}, {"paramType"=>"form", "name"=>"course_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[prefer_sis_email]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
343
|
+
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"client_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_rce_favorite", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["disabled", "enabled"]}, {"paramType"=>"form", "name"=>"course_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[prefer_sis_email]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
344
|
+
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"client_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_rce_favorite", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["disabled", "enabled"]}, {"paramType"=>"form", "name"=>"course_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[prefer_sis_email]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
324
345
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
325
346
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
326
347
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
327
348
|
"DELETE_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:, external_tool_id:) { "accounts/#{account_id}/external_tools/#{external_tool_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"external_tool_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
328
349
|
"ADD_TOOL_TO_RCE_FAVORITES" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/external_tools/rce_favorites/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
329
350
|
"REMOVE_TOOL_FROM_RCE_FAVORITES" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/external_tools/rce_favorites/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
351
|
+
"GET_VISIBLE_COURSE_NAVIGATION_TOOLS" => { uri: ->() { "external_tools/visible_course_nav_tools" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
352
|
+
"GET_VISIBLE_COURSE_NAVIGATION_TOOLS_FOR_SINGLE_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools/visible_course_nav_tools" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
330
353
|
"LIST_FAVORITE_COURSES" => { uri: ->() { "users/self/favorites/courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
331
354
|
"LIST_FAVORITE_GROUPS" => { uri: ->() { "users/self/favorites/groups" }, method: "GET", parameters: [] },
|
332
355
|
"ADD_COURSE_TO_FAVORITES" => { uri: ->(id:) { "users/self/favorites/courses/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -341,6 +364,7 @@ module LMS
|
|
341
364
|
"LIST_ENABLED_FEATURES_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/features/enabled" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
342
365
|
"LIST_ENABLED_FEATURES_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/features/enabled" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
343
366
|
"LIST_ENABLED_FEATURES_USERS" => { uri: ->(user_id:) { "users/#{user_id}/features/enabled" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
367
|
+
"LIST_ENVIRONMENT_FEATURES" => { uri: ->() { "features/environment" }, method: "GET", parameters: [] },
|
344
368
|
"GET_FEATURE_FLAG_COURSES" => { uri: ->(course_id:, feature:) { "courses/#{course_id}/features/flags/#{feature}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"feature", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
345
369
|
"GET_FEATURE_FLAG_ACCOUNTS" => { uri: ->(account_id:, feature:) { "accounts/#{account_id}/features/flags/#{feature}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"feature", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
346
370
|
"GET_FEATURE_FLAG_USERS" => { uri: ->(user_id:, feature:) { "users/#{user_id}/features/flags/#{feature}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"feature", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -458,7 +482,8 @@ module LMS
|
|
458
482
|
"LIST_RECENT_HISTORY_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/history" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
459
483
|
"FIND_IMAGES" => { uri: ->() { "image_search" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"query", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
460
484
|
"CONFIRM_IMAGE_SELECTION" => { uri: ->(id:) { "image_selection/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
461
|
-
"
|
485
|
+
"CREATE_INSTACCESS_TOKEN" => { uri: ->() { "inst_access_tokens" }, method: "POST", parameters: [] },
|
486
|
+
"CREATE_JWT" => { uri: ->() { "jwts" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"workflows", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
462
487
|
"REFRESH_JWT" => { uri: ->() { "jwts/refresh" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"jwt", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
463
488
|
"GET_LATE_POLICY" => { uri: ->(id:) { "courses/#{id}/late_policy" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
464
489
|
"CREATE_LATE_POLICY" => { uri: ->(id:) { "courses/#{id}/late_policy" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[missing_submission_deduction_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[missing_submission_deduction]", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[late_submission_deduction_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[late_submission_deduction]", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[late_submission_interval]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[late_submission_minimum_percent_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"late_policy[late_submission_minimum_percent]", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -474,8 +499,8 @@ module LMS
|
|
474
499
|
"LIST_LIVE_ASSESSMENTS" => { uri: ->(course_id:) { "courses/#{course_id}/live_assessments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
475
500
|
"LIST_USER_LOGINS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/logins" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
476
501
|
"LIST_USER_LOGINS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/logins" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
477
|
-
"CREATE_USER_LOGIN" => { uri: ->(account_id:) { "accounts/#{account_id}/logins" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
478
|
-
"EDIT_USER_LOGIN" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/logins/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
502
|
+
"CREATE_USER_LOGIN" => { uri: ->(account_id:) { "accounts/#{account_id}/logins" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[declared_user_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
503
|
+
"EDIT_USER_LOGIN" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/logins/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "suspended"]}, {"paramType"=>"form", "name"=>"login[declared_user_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
479
504
|
"DELETE_USER_LOGIN" => { uri: ->(user_id:, id:) { "users/#{user_id}/logins/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
480
505
|
"LIST_MEDIA_TRACKS_FOR_MEDIA_OBJECT" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}/media_tracks" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["content", "webvtt_content", "updated_at", "created_at"], "items"=>{"type"=>"string"}}] },
|
481
506
|
"UPDATE_MEDIA_TRACKS" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}/media_tracks" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
@@ -604,8 +629,8 @@ module LMS
|
|
604
629
|
"GET_ALL_USERS_IN_GROUP_LTI" => { uri: ->(group_id:) { "/lti/groups/#{group_id}/users" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
605
630
|
"GET_SINGLE_SUBMISSION" => { uri: ->(assignment_id:, submission_id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
606
631
|
"GET_HISTORY_OF_SINGLE_SUBMISSION" => { uri: ->(assignment_id:, submission_id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}/history" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
607
|
-
"LIST_PLANNER_ITEMS_PLANNER" => { uri: ->() { "planner/items" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["new_activity"]}] },
|
608
|
-
"LIST_PLANNER_ITEMS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/planner/items" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["new_activity"]}] },
|
632
|
+
"LIST_PLANNER_ITEMS_PLANNER" => { uri: ->() { "planner/items" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"observed_user_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"filter", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["new_activity"]}] },
|
633
|
+
"LIST_PLANNER_ITEMS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/planner/items" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"observed_user_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"filter", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["new_activity"]}] },
|
609
634
|
"LIST_PLANNER_NOTES" => { uri: ->() { "planner_notes" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"start_date", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_date", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context_codes", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
610
635
|
"SHOW_PLANNER_NOTE" => { uri: ->(id:) { "planner_notes/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
611
636
|
"UPDATE_PLANNER_NOTE" => { uri: ->(id:) { "planner_notes/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"title", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"details", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"todo_date", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
@@ -630,18 +655,19 @@ module LMS
|
|
630
655
|
"CREATE_SINGLE_POLL_CHOICE" => { uri: ->(poll_id:) { "polls/#{poll_id}/poll_choices" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"poll_choices[text]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"poll_choices[is_correct]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"boolean"}}, {"paramType"=>"form", "name"=>"poll_choices[position]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
631
656
|
"UPDATE_SINGLE_POLL_CHOICE" => { uri: ->(poll_id:, id:) { "polls/#{poll_id}/poll_choices/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"poll_choices[text]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"poll_choices[is_correct]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"boolean"}}, {"paramType"=>"form", "name"=>"poll_choices[position]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
632
657
|
"DELETE_POLL_CHOICE" => { uri: ->(poll_id:, id:) { "polls/#{poll_id}/poll_choices/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
633
|
-
"GET_SINGLE_POLL_SUBMISSION" => { uri: ->(poll_id:, poll_session_id:, id:) { "polls/#{poll_id}/poll_sessions/#{poll_session_id}/poll_submissions/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"poll_session_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
634
|
-
"CREATE_SINGLE_POLL_SUBMISSION" => { uri: ->(poll_id:, poll_session_id:) { "polls/#{poll_id}/poll_sessions/#{poll_session_id}/poll_submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"poll_session_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"poll_submissions[poll_choice_id]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
635
658
|
"LIST_POLLS" => { uri: ->() { "polls" }, method: "GET", parameters: [] },
|
636
659
|
"GET_SINGLE_POLL" => { uri: ->(id:) { "polls/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
637
660
|
"CREATE_SINGLE_POLL" => { uri: ->() { "polls" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"polls[question]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"polls[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
638
661
|
"UPDATE_SINGLE_POLL" => { uri: ->(id:) { "polls/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"polls[question]", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"polls[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
639
662
|
"DELETE_POLL" => { uri: ->(id:) { "polls/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
663
|
+
"GET_SINGLE_POLL_SUBMISSION" => { uri: ->(poll_id:, poll_session_id:, id:) { "polls/#{poll_id}/poll_sessions/#{poll_session_id}/poll_submissions/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"poll_session_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
664
|
+
"CREATE_SINGLE_POLL_SUBMISSION" => { uri: ->(poll_id:, poll_session_id:) { "polls/#{poll_id}/poll_sessions/#{poll_session_id}/poll_submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"poll_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"poll_session_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"poll_submissions[poll_choice_id]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
640
665
|
"CREATE_UPDATE_PROFICIENCY_RATINGS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/outcome_proficiency" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"ratings[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"ratings[points]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[mastery]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[color]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
641
666
|
"CREATE_UPDATE_PROFICIENCY_RATINGS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/outcome_proficiency" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"ratings[description]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"ratings[points]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[mastery]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"ratings[color]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
642
667
|
"GET_PROFICIENCY_RATINGS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/outcome_proficiency" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
643
668
|
"GET_PROFICIENCY_RATINGS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/outcome_proficiency" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
644
669
|
"QUERY_PROGRESS" => { uri: ->(id:) { "progress/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
670
|
+
"PROGRESS_QUERY_PROGRESS" => { uri: ->(course_id:, id:) { "/lti/courses/#{course_id}/progress/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
645
671
|
"UPDATE_PUBLIC_JWK" => { uri: ->() { "/lti/developer_key/update_public_jwk" }, method: "PUT", parameters: [{"paramType"=>"form", "name"=>"public_jwk", "type"=>"json", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
646
672
|
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_CLASSIC_QUIZZES" => { uri: ->(course_id:) { "courses/#{course_id}/quizzes/assignment_overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
647
673
|
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_NEW_QUIZZES" => { uri: ->(course_id:) { "courses/#{course_id}/new_quizzes/assignment_overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
@@ -667,6 +693,7 @@ module LMS
|
|
667
693
|
"QUIZ_SUBMISSION_FILES_UPLOAD_FILE" => { uri: ->(course_id:, quiz_id:) { "courses/#{course_id}/quizzes/#{quiz_id}/submissions/self/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"quiz_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"on_duplicate", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
668
694
|
"GET_ALL_QUIZ_SUBMISSION_QUESTIONS" => { uri: ->(quiz_submission_id:) { "quiz_submissions/#{quiz_submission_id}/questions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["quiz_question"], "items"=>{"type"=>"string"}}] },
|
669
695
|
"ANSWERING_QUESTIONS" => { uri: ->(quiz_submission_id:) { "quiz_submissions/#{quiz_submission_id}/questions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attempt", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"validation_token", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"quiz_questions", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"QuizSubmissionQuestion"}}] },
|
696
|
+
"GET_FORMATTED_STUDENT_NUMERICAL_ANSWER" => { uri: ->(quiz_submission_id:, id:) { "quiz_submissions/#{quiz_submission_id}/questions/#{id}/formatted_answer" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"answer", "type"=>"Numeric", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
670
697
|
"FLAGGING_QUESTION" => { uri: ->(quiz_submission_id:, id:) { "quiz_submissions/#{quiz_submission_id}/questions/#{id}/flag" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attempt", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"validation_token", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
671
698
|
"UNFLAGGING_QUESTION" => { uri: ->(quiz_submission_id:, id:) { "quiz_submissions/#{quiz_submission_id}/questions/#{id}/unflag" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"quiz_submission_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attempt", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"validation_token", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
672
699
|
"SEND_MESSAGE_TO_UNSUBMITTED_OR_SUBMITTED_USERS_FOR_QUIZ" => { uri: ->(course_id:, id:) { "courses/#{course_id}/quizzes/#{id}/submission_users/message" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"conversations", "type"=>"QuizUserConversation", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
@@ -705,18 +732,6 @@ module LMS
|
|
705
732
|
"CREATE_RUBRICASSOCIATION" => { uri: ->(course_id:) { "courses/#{course_id}/rubric_associations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[rubric_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[association_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[association_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["Assignment", "Course", "Account"]}, {"paramType"=>"form", "name"=>"rubric_association[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[use_for_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[hide_score_total]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[purpose]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["grading", "bookmark"]}, {"paramType"=>"form", "name"=>"rubric_association[bookmarked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
706
733
|
"UPDATE_RUBRICASSOCIATION" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubric_associations/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[rubric_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[association_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[association_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["Assignment", "Course", "Account"]}, {"paramType"=>"form", "name"=>"rubric_association[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[use_for_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[hide_score_total]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association[purpose]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["grading", "bookmark"]}, {"paramType"=>"form", "name"=>"rubric_association[bookmarked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
707
734
|
"DELETE_RUBRICASSOCIATION" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubric_associations/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
708
|
-
"GET_SIS_IMPORT_ERROR_LIST_SIS_IMPORTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sis_imports/#{id}/errors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"failure", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
709
|
-
"GET_SIS_IMPORT_ERROR_LIST_SIS_IMPORT_ERRORS" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_import_errors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"failure", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
710
|
-
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"created_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["initializing", "created", "importing", "cleanup_batch", "imported", "imported_with_messages", "aborted", "failed", "failed_with_messages", "restoring", "partially_restored", "restored"], "items"=>{"type"=>"string"}}] },
|
711
|
-
"GET_CURRENT_IMPORTING_SIS_IMPORT" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_imports/importing" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
712
|
-
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"import_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extension", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"batch_mode_term_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"multi_term_batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"skip_deletes", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"override_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"add_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"clear_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diffing_data_set_identifier", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diffing_remaster_data_set", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diffing_drop_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["deleted", "completed", "inactive"]}, {"paramType"=>"form", "name"=>"change_threshold", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diff_row_count_threshold", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
713
|
-
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
714
|
-
"RESTORE_WORKFLOW_STATES_OF_SIS_IMPORTED_ITEMS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sis_imports/#{id}/restore_states" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"undelete_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"unconclude_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
715
|
-
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
716
|
-
"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, "deprecated"=>false}] },
|
717
|
-
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["student_overrides"]}] },
|
718
|
-
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["student_overrides"]}] },
|
719
|
-
"DISABLE_ASSIGNMENTS_CURRENTLY_ENABLED_FOR_GRADE_EXPORT_TO_SIS" => { uri: ->(course_id:) { "/sis/courses/#{course_id}/disable_post_to_sis" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
720
735
|
"CREATE_SCORE" => { uri: ->(course_id:, line_item_id:) { "/lti/courses/#{course_id}/line_items/#{line_item_id}/scores" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"line_item_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"userId", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"activityProgress", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"gradingProgress", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"timestamp", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"scoreGiven", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"scoreMaximum", "type"=>"number", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"https://canvas.instructure.com/lti/submission", "type"=>"Object", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
721
736
|
"FIND_RECIPIENTS_CONVERSATIONS" => { uri: ->() { "conversations/find_recipients" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"search", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["user", "context"]}, {"paramType"=>"query", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"from_conversation_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"permissions", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
722
737
|
"FIND_RECIPIENTS_SEARCH" => { uri: ->() { "search/recipients" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"search", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"context", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["user", "context"]}, {"paramType"=>"query", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"from_conversation_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"permissions", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
@@ -734,37 +749,61 @@ module LMS
|
|
734
749
|
"SHARE_BRANDCONFIG_THEME" => { uri: ->(account_id:) { "accounts/#{account_id}/shared_brand_configs" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_brand_config[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_brand_config[brand_config_md5]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
735
750
|
"UPDATE_SHARED_THEME" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/shared_brand_configs/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
736
751
|
"UN_SHARE_BRANDCONFIG_THEME" => { uri: ->(id:) { "shared_brand_configs/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
752
|
+
"GET_SIS_IMPORT_ERROR_LIST_SIS_IMPORTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sis_imports/#{id}/errors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"failure", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
753
|
+
"GET_SIS_IMPORT_ERROR_LIST_SIS_IMPORT_ERRORS" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_import_errors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"failure", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
754
|
+
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"created_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"created_before", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["initializing", "created", "importing", "cleanup_batch", "imported", "imported_with_messages", "aborted", "failed", "failed_with_messages", "restoring", "partially_restored", "restored"], "items"=>{"type"=>"string"}}] },
|
755
|
+
"GET_CURRENT_IMPORTING_SIS_IMPORT" => { uri: ->(account_id:) { "accounts/#{account_id}/sis_imports/importing" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
756
|
+
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"import_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"extension", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"batch_mode_term_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"multi_term_batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"skip_deletes", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"override_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"add_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"clear_sis_stickiness", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"update_sis_id_if_login_claimed", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diffing_data_set_identifier", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diffing_remaster_data_set", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diffing_drop_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["deleted", "completed", "inactive"]}, {"paramType"=>"form", "name"=>"batch_mode_enrollment_drop_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["deleted", "completed", "inactive"]}, {"paramType"=>"form", "name"=>"change_threshold", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"diff_row_count_threshold", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
757
|
+
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
758
|
+
"RESTORE_WORKFLOW_STATES_OF_SIS_IMPORTED_ITEMS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/sis_imports/#{id}/restore_states" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"batch_mode", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"undelete_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"unconclude_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
759
|
+
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
760
|
+
"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, "deprecated"=>false}] },
|
761
|
+
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["student_overrides"]}] },
|
762
|
+
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["student_overrides"]}] },
|
763
|
+
"DISABLE_ASSIGNMENTS_CURRENTLY_ENABLED_FOR_GRADE_EXPORT_TO_SIS" => { uri: ->(course_id:) { "/sis/courses/#{course_id}/disable_post_to_sis" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
737
764
|
"EDIT_SUBMISSION_COMMENT" => { uri: ->(course_id:, assignment_id:, user_id:, id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/comments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
738
765
|
"DELETE_SUBMISSION_COMMENT" => { uri: ->(course_id:, assignment_id:, user_id:, id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/comments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
739
766
|
"SUBMISSION_COMMENTS_UPLOAD_FILE" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/comments/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
740
|
-
"SUBMIT_ASSIGNMENT_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
741
|
-
"SUBMIT_ASSIGNMENT_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
742
|
-
"LIST_ASSIGNMENT_SUBMISSIONS_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "visibility", "course", "user", "group"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
743
|
-
"LIST_ASSIGNMENT_SUBMISSIONS_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "visibility", "course", "user", "group"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
767
|
+
"SUBMIT_ASSIGNMENT_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch", "student_annotation"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
768
|
+
"SUBMIT_ASSIGNMENT_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submission_type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["online_text_entry", "online_url", "online_upload", "media_recording", "basic_lti_launch", "student_annotation"]}, {"paramType"=>"form", "name"=>"submission[body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"submission[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"submission[user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[annotatable_attachment_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[submitted_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
769
|
+
"LIST_ASSIGNMENT_SUBMISSIONS_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "visibility", "course", "user", "group", "read_status"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
770
|
+
"LIST_ASSIGNMENT_SUBMISSIONS_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "visibility", "course", "user", "group", "read_status"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
744
771
|
"LIST_SUBMISSIONS_FOR_MULTIPLE_ASSIGNMENTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/students/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"student_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"submitted_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"graded_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submitted", "unsubmitted", "graded", "pending_review"]}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "concluded"]}, {"paramType"=>"query", "name"=>"state_based_on_date", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["id", "graded_at"]}, {"paramType"=>"query", "name"=>"order_direction", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ascending", "descending"]}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "total_scores", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
745
772
|
"LIST_SUBMISSIONS_FOR_MULTIPLE_ASSIGNMENTS_SECTIONS" => { uri: ->(section_id:) { "sections/#{section_id}/students/submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"student_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"submitted_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"graded_since", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submitted", "unsubmitted", "graded", "pending_review"]}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "concluded"]}, {"paramType"=>"query", "name"=>"state_based_on_date", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["id", "graded_at"]}, {"paramType"=>"query", "name"=>"order_direction", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ascending", "descending"]}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "assignment", "total_scores", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
746
|
-
"GET_SINGLE_SUBMISSION_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "full_rubric_assessment", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
747
|
-
"GET_SINGLE_SUBMISSION_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "full_rubric_assessment", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
773
|
+
"GET_SINGLE_SUBMISSION_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "full_rubric_assessment", "visibility", "course", "user", "read_status"], "items"=>{"type"=>"string"}}] },
|
774
|
+
"GET_SINGLE_SUBMISSION_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "full_rubric_assessment", "visibility", "course", "user", "read_status"], "items"=>{"type"=>"string"}}] },
|
775
|
+
"GET_SINGLE_SUBMISSION_BY_ANONYMOUS_ID_COURSES" => { uri: ->(course_id:, assignment_id:, anonymous_id:) { "courses/#{course_id}/assignments/#{assignment_id}/anonymous_submissions/#{anonymous_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"anonymous_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "full_rubric_assessment", "visibility", "course", "user", "read_status"], "items"=>{"type"=>"string"}}] },
|
776
|
+
"GET_SINGLE_SUBMISSION_BY_ANONYMOUS_ID_SECTIONS" => { uri: ->(section_id:, assignment_id:, anonymous_id:) { "sections/#{section_id}/assignments/#{assignment_id}/anonymous_submissions/#{anonymous_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"anonymous_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission_history", "submission_comments", "rubric_assessment", "full_rubric_assessment", "visibility", "course", "user", "read_status"], "items"=>{"type"=>"string"}}] },
|
748
777
|
"UPLOAD_FILE_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
749
778
|
"UPLOAD_FILE_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
750
779
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"comment[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"include[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[late_policy_status]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[seconds_late_override]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
751
780
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"comment[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"include[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[late_policy_status]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[seconds_late_override]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
781
|
+
"GRADE_OR_COMMENT_ON_SUBMISSION_BY_ANONYMOUS_ID_COURSES" => { uri: ->(course_id:, assignment_id:, anonymous_id:) { "courses/#{course_id}/assignments/#{assignment_id}/anonymous_submissions/#{anonymous_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"anonymous_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"comment[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"include[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[late_policy_status]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[seconds_late_override]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
782
|
+
"GRADE_OR_COMMENT_ON_SUBMISSION_BY_ANONYMOUS_ID_SECTIONS" => { uri: ->(section_id:, assignment_id:, anonymous_id:) { "sections/#{section_id}/assignments/#{assignment_id}/anonymous_submissions/#{anonymous_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"anonymous_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment[media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"comment[file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"include[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[late_policy_status]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"submission[seconds_late_override]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
752
783
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
753
784
|
"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, "deprecated"=>false}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
754
|
-
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<
|
755
|
-
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<
|
756
|
-
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<
|
757
|
-
"GRADE_OR_COMMENT_ON_MULTIPLE_SUBMISSIONS_SECTIONS_ASSIGNMENTS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/update_grades" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<
|
785
|
+
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<assignment_id>][<student_id>]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
786
|
+
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<assignment_id>][<student_id>]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
787
|
+
"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, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<assignment_id>][<student_id>]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
788
|
+
"GRADE_OR_COMMENT_ON_MULTIPLE_SUBMISSIONS_SECTIONS_ASSIGNMENTS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/update_grades" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][posted_grade]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][excuse]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][rubric_assessment]", "type"=>"RubricAssessment", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][text_comment]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][group_comment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][media_comment_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"grade_data[<student_id>][file_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"grade_data[<assignment_id>][<student_id>]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
758
789
|
"MARK_SUBMISSION_AS_READ_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/read" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
759
790
|
"MARK_SUBMISSION_AS_READ_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/read" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
760
791
|
"MARK_SUBMISSION_AS_UNREAD_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/read" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
761
792
|
"MARK_SUBMISSION_AS_UNREAD_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/read" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
793
|
+
"GET_RUBRIC_COMMENTS_READ_STATE_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/rubric_comments/read" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
794
|
+
"GET_RUBRIC_COMMENTS_READ_STATE_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/rubric_comments/read" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
795
|
+
"MARK_RUBRIC_COMMENTS_AS_READ_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/rubric_comments/read" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
796
|
+
"MARK_RUBRIC_COMMENTS_AS_READ_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/rubric_comments/read" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
797
|
+
"GET_DOCUMENT_ANNOTATIONS_READ_STATE_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/document_annotations/read" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
798
|
+
"GET_DOCUMENT_ANNOTATIONS_READ_STATE_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/document_annotations/read" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
799
|
+
"MARK_DOCUMENT_ANNOTATIONS_AS_READ_COURSES" => { uri: ->(course_id:, assignment_id:, user_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}/document_annotations/read" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
800
|
+
"MARK_DOCUMENT_ANNOTATIONS_AS_READ_SECTIONS" => { uri: ->(section_id:, assignment_id:, user_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submissions/#{user_id}/document_annotations/read" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
762
801
|
"SUBMISSION_SUMMARY_COURSES" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/submission_summary" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
763
802
|
"SUBMISSION_SUMMARY_SECTIONS" => { uri: ->(section_id:, assignment_id:) { "sections/#{section_id}/assignments/#{assignment_id}/submission_summary" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grouped", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
764
|
-
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
765
|
-
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
766
|
-
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
767
|
-
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_USERS" => { uri: ->(user_id:) { "users/#{user_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
803
|
+
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course_subject_tabs"], "items"=>{"type"=>"string"}}] },
|
804
|
+
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course_subject_tabs"], "items"=>{"type"=>"string"}}] },
|
805
|
+
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course_subject_tabs"], "items"=>{"type"=>"string"}}] },
|
806
|
+
"LIST_AVAILABLE_TABS_FOR_COURSE_OR_GROUP_USERS" => { uri: ->(user_id:) { "users/#{user_id}/tabs" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["course_subject_tabs"], "items"=>{"type"=>"string"}}] },
|
768
807
|
"UPDATE_TAB_FOR_COURSE" => { uri: ->(course_id:, tab_id:) { "courses/#{course_id}/tabs/#{tab_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"tab_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"position", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hidden", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
769
808
|
"LIST_OBSERVEES" => { uri: ->(user_id:) { "users/#{user_id}/observees" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url"], "items"=>{"type"=>"string"}}] },
|
770
809
|
"LIST_OBSERVERS" => { uri: ->(user_id:) { "users/#{user_id}/observers" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url"], "items"=>{"type"=>"string"}}] },
|
@@ -781,20 +820,21 @@ module LMS
|
|
781
820
|
"LIST_TODO_ITEMS" => { uri: ->() { "users/self/todo" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ungraded_quizzes"], "items"=>{"type"=>"string"}}] },
|
782
821
|
"LIST_COUNTS_FOR_TODO_ITEMS" => { uri: ->() { "users/self/todo_item_count" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ungraded_quizzes"], "items"=>{"type"=>"string"}}] },
|
783
822
|
"LIST_UPCOMING_ASSIGNMENTS_CALENDAR_EVENTS" => { uri: ->() { "users/self/upcoming_events" }, method: "GET", parameters: [] },
|
784
|
-
"LIST_MISSING_SUBMISSIONS" => { uri: ->(user_id:) { "users/#{user_id}/missing_submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["planner_overrides", "course"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submittable"], "items"=>{"type"=>"string"}}] },
|
823
|
+
"LIST_MISSING_SUBMISSIONS" => { uri: ->(user_id:) { "users/#{user_id}/missing_submissions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"observed_user_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["planner_overrides", "course"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submittable"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"course_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
785
824
|
"HIDE_STREAM_ITEM" => { uri: ->(id:) { "users/self/activity_stream/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
786
825
|
"HIDE_ALL_STREAM_ITEMS" => { uri: ->() { "users/self/activity_stream" }, method: "DELETE", parameters: [] },
|
787
826
|
"USERS_UPLOAD_FILE" => { uri: ->(user_id:) { "users/#{user_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
788
827
|
"SHOW_USER_DETAILS" => { uri: ->(id:) { "users/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["uuid", "last_login"], "items"=>{"type"=>"string"}}] },
|
789
828
|
"CREATE_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/users" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[terms_of_use]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[skip_registration]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[send_confirmation]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[force_self_registration]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[address]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[confirmation_url]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[skip_confirmation]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"force_validations", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enable_sis_reactivation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"destination", "type"=>"URL", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"initial_enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pairing_code[code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
790
829
|
"DEPRECATED_SELF_REGISTER_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/self_registration" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[terms_of_use]", "type"=>"boolean", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pseudonym[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"communication_channel[address]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
791
|
-
"UPDATE_USER_SETTINGS" => { uri: ->(id:) { "users/#{id}/settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"manual_mark_as_read", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"collapse_global_nav", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"hide_dashcard_color_overlays", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
830
|
+
"UPDATE_USER_SETTINGS" => { uri: ->(id:) { "users/#{id}/settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"manual_mark_as_read", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"release_notes_badge_disabled", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"collapse_global_nav", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"hide_dashcard_color_overlays", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"comment_library_suggestions_enabled", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"elementary_dashboard_disabled", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
792
831
|
"GET_CUSTOM_COLORS" => { uri: ->(id:) { "users/#{id}/colors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
793
832
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"asset_string", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
794
833
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"asset_string", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hexcode", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
795
834
|
"GET_DASHBOARD_POSITIONS" => { uri: ->(id:) { "users/#{id}/dashboard_positions" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
796
835
|
"UPDATE_DASHBOARD_POSITIONS" => { uri: ->(id:) { "users/#{id}/dashboard_positions" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
797
|
-
"EDIT_USER" => { uri: ->(id:) { "users/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[email]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][token]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[bio]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[pronouns]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
836
|
+
"EDIT_USER" => { uri: ->(id:) { "users/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[email]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][token]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[avatar][url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[bio]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[pronouns]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[event]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["suspend", "unsuspend"]}] },
|
837
|
+
"TERMINATE_ALL_USER_SESSIONS" => { uri: ->(id:) { "users/#{id}/sessions" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
798
838
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"destination_user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
799
839
|
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"destination_account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"destination_user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
800
840
|
"SPLIT_MERGED_USERS_INTO_SEPARATE_USERS" => { uri: ->(id:) { "users/#{id}/split" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
@@ -815,9 +855,6 @@ module LMS
|
|
815
855
|
"DELETE_WEBHOOK_SUBSCRIPTION" => { uri: ->(id:) { "/lti/subscriptions/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
816
856
|
"SHOW_SINGLE_WEBHOOK_SUBSCRIPTION" => { uri: ->(id:) { "/lti/subscriptions/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
817
857
|
"UPDATE_WEBHOOK_SUBSCRIPTION" => { uri: ->(id:) { "/lti/subscriptions/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
818
|
-
"LIST_ALL_WEBHOOK_SUBSCRIPTION_FOR_TOOL_PROXY" => { uri: ->() { "/lti/subscriptions" }, method: "GET", parameters: [] }
|
819
|
-
"LIST_COURSES_WITH_THEIR_LATEST_EPUB_EXPORT" => { uri: ->() { "epub_exports" }, method: "GET", parameters: [] },
|
820
|
-
"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, "deprecated"=>false}] },
|
821
|
-
"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, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] }
|
858
|
+
"LIST_ALL_WEBHOOK_SUBSCRIPTION_FOR_TOOL_PROXY" => { uri: ->() { "/lti/subscriptions" }, method: "GET", parameters: [] }
|
822
859
|
}
|
823
860
|
end
|