lms-api 1.12.1 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lms/canvas_urls.rb +87 -47
- data/lib/lms/course_ids_required.rb +19 -0
- data/lib/lms/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: add37b0ff6377c171a4ae75b330c427bf698e9e6
|
|
4
|
+
data.tar.gz: aa1d1ffab6f2df16194ff82654aa57c68c53e244
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7ad1b532ca03468825bfc5336c094685997d69bb456d284185cb859d18a13d7181347a3a4bc5baecee45737ec1a08d0ef9d7ae2d6386a7a89adbbe30d07a2738
|
|
7
|
+
data.tar.gz: b0d4199728f0860c4256a7fe48d36fc900bb16f10d1a9bba51c3b7d12740ec309256184c67d9399dc790de67f2f8b99a70ae304d008057edaa3807113acbbb97
|
data/lib/lms/canvas_urls.rb
CHANGED
|
@@ -19,8 +19,8 @@ module LMS
|
|
|
19
19
|
"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
20
|
"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
21
|
"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
|
-
"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"], "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"]}] },
|
|
23
|
-
"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[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][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][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[services]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
22
|
+
"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"]}] },
|
|
23
|
+
"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[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][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[services]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
24
24
|
"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
25
|
"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
26
|
"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}] },
|
|
@@ -64,12 +64,12 @@ module LMS
|
|
|
64
64
|
"EDIT_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
65
65
|
"DESTROY_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"move_assignments_to", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
66
66
|
"DELETE_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
67
|
-
"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"], "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"]}] },
|
|
68
|
-
"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"], "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"]}] },
|
|
67
|
+
"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"], "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"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
68
|
+
"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"], "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"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
69
69
|
"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}] },
|
|
70
70
|
"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"], "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}] },
|
|
71
|
-
"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"]}, {"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[muted]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>
|
|
72
|
-
"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[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"]}, {"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[muted]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>
|
|
71
|
+
"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"]}, {"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[muted]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>true}, {"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}] },
|
|
72
|
+
"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"]}, {"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[muted]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>true}, {"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}] },
|
|
73
73
|
"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}] },
|
|
74
74
|
"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}] },
|
|
75
75
|
"REDIRECT_TO_ASSIGNMENT_OVERRIDE_FOR_GROUP" => { uri: ->(group_id:, assignment_id:) { "groups/#{group_id}/assignments/#{assignment_id}/override" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -110,7 +110,7 @@ module LMS
|
|
|
110
110
|
"DELETE_BOOKMARK" => { uri: ->(id:) { "users/self/bookmarks/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
111
111
|
"GET_BRAND_CONFIG_VARIABLES_THAT_SHOULD_BE_USED_FOR_THIS_DOMAIN" => { uri: ->() { "brand_variables" }, method: "GET", parameters: [] },
|
|
112
112
|
"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"}}] },
|
|
113
|
-
"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"}}] },
|
|
113
|
+
"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"}}] },
|
|
114
114
|
"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}] },
|
|
115
115
|
"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}] },
|
|
116
116
|
"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}] },
|
|
@@ -162,10 +162,10 @@ module LMS
|
|
|
162
162
|
"GET_CONTENT_MIGRATION_COURSES" => { uri: ->(course_id:, id:) { "courses/#{course_id}/content_migrations/#{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}] },
|
|
163
163
|
"GET_CONTENT_MIGRATION_GROUPS" => { uri: ->(group_id:, id:) { "groups/#{group_id}/content_migrations/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
164
164
|
"GET_CONTENT_MIGRATION_USERS" => { uri: ->(user_id:, id:) { "users/#{user_id}/content_migrations/#{id}" }, method: "GET", 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}] },
|
|
165
|
-
"CREATE_CONTENT_MIGRATION_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
166
|
-
"CREATE_CONTENT_MIGRATION_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
167
|
-
"CREATE_CONTENT_MIGRATION_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
168
|
-
"CREATE_CONTENT_MIGRATION_USERS" => { uri: ->(user_id:) { "users/#{user_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
165
|
+
"CREATE_CONTENT_MIGRATION_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[content_export_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"selective_import", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"select", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["folders", "files", "attachments", "quizzes", "assignments", "announcements", "calendar_events", "discussion_topics", "modules", "module_items", "pages", "rubrics"]}] },
|
|
166
|
+
"CREATE_CONTENT_MIGRATION_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[content_export_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"selective_import", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"select", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["folders", "files", "attachments", "quizzes", "assignments", "announcements", "calendar_events", "discussion_topics", "modules", "module_items", "pages", "rubrics"]}] },
|
|
167
|
+
"CREATE_CONTENT_MIGRATION_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[content_export_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"selective_import", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"select", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["folders", "files", "attachments", "quizzes", "assignments", "announcements", "calendar_events", "discussion_topics", "modules", "module_items", "pages", "rubrics"]}] },
|
|
168
|
+
"CREATE_CONTENT_MIGRATION_USERS" => { uri: ->(user_id:) { "users/#{user_id}/content_migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pre_attachment[*]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[file_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[content_export_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[source_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[folder_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[overwrite_quizzes]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings[question_bank_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[shift_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[old_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_start_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[new_end_date]", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[day_substitutions][X]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"date_shift_options[remove_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"selective_import", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"select", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["folders", "files", "attachments", "quizzes", "assignments", "announcements", "calendar_events", "discussion_topics", "modules", "module_items", "pages", "rubrics"]}] },
|
|
169
169
|
"UPDATE_CONTENT_MIGRATION_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/content_migrations/#{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}] },
|
|
170
170
|
"UPDATE_CONTENT_MIGRATION_COURSES" => { uri: ->(course_id:, id:) { "courses/#{course_id}/content_migrations/#{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}] },
|
|
171
171
|
"UPDATE_CONTENT_MIGRATION_GROUPS" => { uri: ->(group_id:, id:) { "groups/#{group_id}/content_migrations/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -174,6 +174,10 @@ module LMS
|
|
|
174
174
|
"LIST_MIGRATION_SYSTEMS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/content_migrations/migrators" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
175
175
|
"LIST_MIGRATION_SYSTEMS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/content_migrations/migrators" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
176
176
|
"LIST_MIGRATION_SYSTEMS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/content_migrations/migrators" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
177
|
+
"LIST_ITEMS_FOR_SELECTIVE_IMPORT_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/content_migrations/#{id}/selective_data" }, 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"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["context_modules", "assignments", "quizzes", "assessment_question_banks", "discussion_topics", "wiki_pages", "context_external_tools", "tool_profiles", "announcements", "calendar_events", "rubrics", "groups", "learning_outcomes", "attachments"]}] },
|
|
178
|
+
"LIST_ITEMS_FOR_SELECTIVE_IMPORT_COURSES" => { uri: ->(course_id:, id:) { "courses/#{course_id}/content_migrations/#{id}/selective_data" }, 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"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["context_modules", "assignments", "quizzes", "assessment_question_banks", "discussion_topics", "wiki_pages", "context_external_tools", "tool_profiles", "announcements", "calendar_events", "rubrics", "groups", "learning_outcomes", "attachments"]}] },
|
|
179
|
+
"LIST_ITEMS_FOR_SELECTIVE_IMPORT_GROUPS" => { uri: ->(group_id:, id:) { "groups/#{group_id}/content_migrations/#{id}/selective_data" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["context_modules", "assignments", "quizzes", "assessment_question_banks", "discussion_topics", "wiki_pages", "context_external_tools", "tool_profiles", "announcements", "calendar_events", "rubrics", "groups", "learning_outcomes", "attachments"]}] },
|
|
180
|
+
"LIST_ITEMS_FOR_SELECTIVE_IMPORT_USERS" => { uri: ->(user_id:, id:) { "users/#{user_id}/content_migrations/#{id}/selective_data" }, method: "GET", 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}, {"paramType"=>"query", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["context_modules", "assignments", "quizzes", "assessment_question_banks", "discussion_topics", "wiki_pages", "context_external_tools", "tool_profiles", "announcements", "calendar_events", "rubrics", "groups", "learning_outcomes", "attachments"]}] },
|
|
177
181
|
"GET_CURRENT_SETTINGS_FOR_ACCOUNT_OR_COURSE_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/csp_settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
178
182
|
"GET_CURRENT_SETTINGS_FOR_ACCOUNT_OR_COURSE_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_settings" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
179
183
|
"ENABLE_DISABLE_OR_CLEAR_EXPLICIT_CSP_SETTING_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/csp_settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"status", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["enabled", "disabled", "inherited"]}] },
|
|
@@ -181,7 +185,15 @@ module LMS
|
|
|
181
185
|
"LOCK_OR_UNLOCK_CURRENT_CSP_SETTINGS_FOR_SUB_ACCOUNTS_AND_COURSES" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_settings/lock" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"settings_locked", "type"=>"boolean", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
182
186
|
"ADD_DOMAIN_TO_ACCOUNT_WHITELIST" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_settings/domains" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
183
187
|
"ADD_MULTIPLE_DOMAINS_TO_ACCOUNT_WHITELIST" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_settings/domains/batch_create" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domains", "type"=>"Array", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
188
|
+
"RETRIEVE_REPORTED_CSP_VIOLATIONS_FOR_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_log" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
184
189
|
"REMOVE_DOMAIN_FROM_ACCOUNT_WHITELIST" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_settings/domains" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
190
|
+
"CREATE_CONTENT_SHARE" => { uri: ->(user_id:) { "users/#{user_id}/content_shares" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"receiver_ids", "type"=>"Array", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"content_type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["assignment", "discussion_topic", "page", "quiz", "module", "module_item"]}, {"paramType"=>"form", "name"=>"content_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}] },
|
|
191
|
+
"LIST_CONTENT_SHARES_SENT" => { uri: ->(user_id:) { "users/#{user_id}/content_shares/sent" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
192
|
+
"LIST_CONTENT_SHARES_RECEIVED" => { uri: ->(user_id:) { "users/#{user_id}/content_shares/received" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
193
|
+
"GET_CONTENT_SHARE" => { uri: ->(user_id:, id:) { "users/#{user_id}/content_shares/#{id}" }, method: "GET", 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}] },
|
|
194
|
+
"REMOVE_CONTENT_SHARE" => { uri: ->(user_id:, id:) { "users/#{user_id}/content_shares/#{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}] },
|
|
195
|
+
"ADD_USERS_TO_CONTENT_SHARE" => { uri: ->(user_id:, id:) { "users/#{user_id}/content_shares/#{id}/add_users" }, method: "POST", 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}, {"paramType"=>"form", "name"=>"receiver_ids", "type"=>"Array", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
196
|
+
"UPDATE_CONTENT_SHARE" => { uri: ->(user_id:, id:) { "users/#{user_id}/content_shares/#{id}" }, method: "PUT", 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}, {"paramType"=>"form", "name"=>"read_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["read", "unread"]}] },
|
|
185
197
|
"LIST_CONVERSATIONS" => { uri: ->() { "conversations" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unread", "starred", "archived"]}, {"paramType"=>"query", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"filter_mode", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["and", "or", "default or"]}, {"paramType"=>"query", "name"=>"interleave_submissions", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include_all_conversation_ids", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["participant_avatars"], "items"=>{"type"=>"string"}}] },
|
|
186
198
|
"CREATE_CONVERSATION" => { uri: ->() { "conversations" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"recipients", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"subject", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"body", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"force_new", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"group_conversation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"attachment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"media_comment_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"media_comment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["audio", "video"]}, {"paramType"=>"form", "name"=>"user_note", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"mode", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["sync", "async"]}, {"paramType"=>"form", "name"=>"scope", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unread", "starred", "archived"]}, {"paramType"=>"form", "name"=>"filter", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"filter_mode", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["and", "or", "default or"]}, {"paramType"=>"form", "name"=>"context_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
187
199
|
"GET_RUNNING_BATCHES" => { uri: ->() { "conversations/batches" }, method: "GET", parameters: [] },
|
|
@@ -197,25 +209,26 @@ module LMS
|
|
|
197
209
|
"UNREAD_COUNT" => { uri: ->() { "conversations/unread_count" }, method: "GET", parameters: [] },
|
|
198
210
|
"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}] },
|
|
199
211
|
"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}] },
|
|
200
|
-
"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"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
|
201
|
-
"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"], "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"]}] },
|
|
202
|
-
"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"=>"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[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[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enable_sis_reactivation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
212
|
+
"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"}}] },
|
|
213
|
+
"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"]}] },
|
|
214
|
+
"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"=>"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[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}] },
|
|
203
215
|
"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}] },
|
|
204
216
|
"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}] },
|
|
205
|
-
"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"=>"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"], "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"}}] },
|
|
206
|
-
"LIST_USERS_IN_COURSE_SEARCH_USERS" => { uri: ->(course_id:) { "courses/#{course_id}/search_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"=>"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"], "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"}}] },
|
|
217
|
+
"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"}}] },
|
|
218
|
+
"LIST_USERS_IN_COURSE_SEARCH_USERS" => { uri: ->(course_id:) { "courses/#{course_id}/search_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"}}] },
|
|
207
219
|
"LIST_RECENTLY_LOGGED_IN_STUDENTS" => { uri: ->(course_id:) { "courses/#{course_id}/recent_students" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
208
220
|
"GET_SINGLE_USER" => { uri: ->(course_id:, id:) { "courses/#{course_id}/users/#{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}] },
|
|
221
|
+
"SEARCH_FOR_CONTENT_SHARE_USERS" => { uri: ->(course_id:) { "courses/#{course_id}/content_share_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"=>true, "deprecated"=>false}] },
|
|
209
222
|
"COURSES_PREVIEW_PROCESSED_HTML" => { uri: ->(course_id:) { "courses/#{course_id}/preview_html" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"html", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
210
223
|
"COURSE_ACTIVITY_STREAM" => { uri: ->(course_id:) { "courses/#{course_id}/activity_stream" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
211
224
|
"COURSE_ACTIVITY_STREAM_SUMMARY" => { uri: ->(course_id:) { "courses/#{course_id}/activity_stream/summary" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
212
225
|
"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}] },
|
|
213
226
|
"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"]}] },
|
|
214
227
|
"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}] },
|
|
215
|
-
"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"=>"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"=>"lock_all_announcements", "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}] },
|
|
216
|
-
"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"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"teacher_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
217
|
-
"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"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"teacher_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
218
|
-
"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[grading_standard_id]", "type"=>"integer", "format"=>"int64", "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}] },
|
|
228
|
+
"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"=>"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}] },
|
|
229
|
+
"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}] },
|
|
230
|
+
"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}] },
|
|
231
|
+
"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[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}] },
|
|
219
232
|
"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"]}] },
|
|
220
233
|
"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}] },
|
|
221
234
|
"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"}}] },
|
|
@@ -280,9 +293,10 @@ module LMS
|
|
|
280
293
|
"UPDATE_ENROLLMENT_TERM" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/terms/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[sis_term_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[overrides][enrollment_type][start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment_term[overrides][enrollment_type][end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
281
294
|
"DELETE_ENROLLMENT_TERM" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/terms/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
282
295
|
"LIST_ENROLLMENT_TERMS" => { uri: ->(account_id:) { "accounts/#{account_id}/terms" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"workflow_state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "deleted", "all"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["overrides"], "items"=>{"type"=>"string"}}] },
|
|
283
|
-
"
|
|
284
|
-
"
|
|
285
|
-
"
|
|
296
|
+
"RETRIEVE_ENROLLMENT_TERM" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/terms/#{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}] },
|
|
297
|
+
"LIST_ENROLLMENTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/enrollments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"type", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"role", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited", "creation_pending", "deleted", "rejected", "completed", "inactive", "current_and_invited", "current_and_future", "current_and_concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url", "group_ids", "locked", "observed_users", "can_be_removed", "uuid"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_term_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sis_account_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_course_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_section_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_user_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"created_for_sis_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"boolean"}}] },
|
|
298
|
+
"LIST_ENROLLMENTS_SECTIONS" => { uri: ->(section_id:) { "sections/#{section_id}/enrollments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"type", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"role", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited", "creation_pending", "deleted", "rejected", "completed", "inactive", "current_and_invited", "current_and_future", "current_and_concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url", "group_ids", "locked", "observed_users", "can_be_removed", "uuid"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_term_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sis_account_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_course_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_section_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_user_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"created_for_sis_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"boolean"}}] },
|
|
299
|
+
"LIST_ENROLLMENTS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/enrollments" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"type", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"role", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited", "creation_pending", "deleted", "rejected", "completed", "inactive", "current_and_invited", "current_and_future", "current_and_concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url", "group_ids", "locked", "observed_users", "can_be_removed", "uuid"], "items"=>{"type"=>"string"}}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_term_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sis_account_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_course_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_section_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"sis_user_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"created_for_sis_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"boolean"}}] },
|
|
286
300
|
"ENROLLMENT_BY_ID" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/enrollments/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}] },
|
|
287
301
|
"ENROLL_USER_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/enrollments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[user_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["StudentEnrollment", "TeacherEnrollment", "TaEnrollment", "ObserverEnrollment", "DesignerEnrollment"]}, {"paramType"=>"form", "name"=>"enrollment[role]", "type"=>"Deprecated", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[role_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[enrollment_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited", "inactive"]}, {"paramType"=>"form", "name"=>"enrollment[course_section_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[limit_privileges_to_course_section]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[notify]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[self_enrollment_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[self_enrolled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[associated_user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
288
302
|
"ENROLL_USER_SECTIONS" => { uri: ->(section_id:) { "sections/#{section_id}/enrollments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"section_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[user_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[type]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["StudentEnrollment", "TeacherEnrollment", "TaEnrollment", "ObserverEnrollment", "DesignerEnrollment"]}, {"paramType"=>"form", "name"=>"enrollment[role]", "type"=>"Deprecated", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[role_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[enrollment_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited", "inactive"]}, {"paramType"=>"form", "name"=>"enrollment[course_section_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[limit_privileges_to_course_section]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[notify]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[self_enrollment_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[self_enrolled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[associated_user_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
@@ -299,8 +313,8 @@ module LMS
|
|
|
299
313
|
"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"]}] },
|
|
300
314
|
"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}] },
|
|
301
315
|
"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}] },
|
|
302
|
-
"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"=>"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"=>"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"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"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}] },
|
|
303
|
-
"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"=>"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"=>"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"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"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}] },
|
|
316
|
+
"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"=>"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"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"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}] },
|
|
317
|
+
"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"=>"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"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"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}] },
|
|
304
318
|
"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}] },
|
|
305
319
|
"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}] },
|
|
306
320
|
"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}] },
|
|
@@ -331,10 +345,10 @@ module LMS
|
|
|
331
345
|
"GET_QUOTA_INFORMATION_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/files/quota" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
332
346
|
"GET_QUOTA_INFORMATION_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/files/quota" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
333
347
|
"GET_QUOTA_INFORMATION_USERS" => { uri: ->(user_id:) { "users/#{user_id}/files/quota" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
334
|
-
"LIST_FILES_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
335
|
-
"LIST_FILES_USERS" => { uri: ->(user_id:) { "users/#{user_id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
336
|
-
"LIST_FILES_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
337
|
-
"LIST_FILES_FOLDERS" => { uri: ->(id:) { "folders/#{id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
348
|
+
"LIST_FILES_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
349
|
+
"LIST_FILES_USERS" => { uri: ->(user_id:) { "users/#{user_id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
350
|
+
"LIST_FILES_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
351
|
+
"LIST_FILES_FOLDERS" => { uri: ->(id:) { "folders/#{id}/files" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_content_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"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"=>["user"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"Array"}}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["name", "size", "created_at", "updated_at", "content_type", "user"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
338
352
|
"GET_PUBLIC_INLINE_PREVIEW_URL" => { uri: ->(id:) { "files/#{id}/public_url" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"submission_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
339
353
|
"GET_FILE_FILES" => { uri: ->(id:) { "files/#{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"=>["user"], "items"=>{"type"=>"string"}}] },
|
|
340
354
|
"GET_FILE_COURSES" => { uri: ->(course_id:, id:) { "courses/#{course_id}/files/#{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"=>["user"], "items"=>{"type"=>"string"}}] },
|
|
@@ -365,6 +379,8 @@ module LMS
|
|
|
365
379
|
"FILES_UPLOAD_FILE" => { uri: ->(folder_id:) { "folders/#{folder_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"folder_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
366
380
|
"COPY_FILE" => { uri: ->(dest_folder_id:) { "folders/#{dest_folder_id}/copy_file" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"dest_folder_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"source_file_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"on_duplicate", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["overwrite", "rename"]}] },
|
|
367
381
|
"COPY_FOLDER" => { uri: ->(dest_folder_id:) { "folders/#{dest_folder_id}/copy_folder" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"dest_folder_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"source_folder_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
382
|
+
"GET_UPLOADED_MEDIA_FOLDER_FOR_USER_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/folders/media" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
383
|
+
"GET_UPLOADED_MEDIA_FOLDER_FOR_USER_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/folders/media" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
368
384
|
"SET_USAGE_RIGHTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/usage_rights" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"file_ids", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"folder_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"publish", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights[use_justification]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["own_copyright", "used_by_permission", "fair_use", "public_domain", "creative_commons"]}, {"paramType"=>"form", "name"=>"usage_rights[legal_copyright]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
369
385
|
"SET_USAGE_RIGHTS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/usage_rights" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"file_ids", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"folder_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"publish", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights[use_justification]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["own_copyright", "used_by_permission", "fair_use", "public_domain", "creative_commons"]}, {"paramType"=>"form", "name"=>"usage_rights[legal_copyright]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
370
386
|
"SET_USAGE_RIGHTS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/usage_rights" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"file_ids", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"folder_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"publish", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights[use_justification]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["own_copyright", "used_by_permission", "fair_use", "public_domain", "creative_commons"]}, {"paramType"=>"form", "name"=>"usage_rights[legal_copyright]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
@@ -427,11 +443,18 @@ module LMS
|
|
|
427
443
|
"UPDATE_MEMBERSHIP_USERS" => { uri: ->(group_id:, user_id:) { "groups/#{group_id}/users/#{user_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_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"=>"workflow_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["accepted"]}, {"paramType"=>"form", "name"=>"moderator", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
428
444
|
"LEAVE_GROUP_MEMBERSHIPS" => { uri: ->(group_id:, membership_id:) { "groups/#{group_id}/memberships/#{membership_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"membership_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
429
445
|
"LEAVE_GROUP_USERS" => { uri: ->(group_id:, user_id:) { "groups/#{group_id}/users/#{user_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
446
|
+
"FIND_IMAGES" => { uri: ->() { "image_search" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"query", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
447
|
+
"CONFIRM_IMAGE_SELECTION" => { uri: ->(id:) { "image_selection/#{id}" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
430
448
|
"CREATE_JWT" => { uri: ->() { "jwts" }, method: "POST", parameters: [] },
|
|
431
449
|
"REFRESH_JWT" => { uri: ->() { "jwts/refresh" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"jwt", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
432
450
|
"GET_LATE_POLICY" => { uri: ->(id:) { "courses/#{id}/late_policy" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
433
451
|
"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}] },
|
|
434
452
|
"PATCH_LATE_POLICY" => { uri: ->(id:) { "courses/#{id}/late_policy" }, method: "PATCH", 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}] },
|
|
453
|
+
"CREATE_LINE_ITEM" => { uri: ->(course_id:) { "/lti/courses/#{course_id}/line_items" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"scoreMaximum", "type"=>"number", "format"=>"float", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"label", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resourceId", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tag", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resourceLinkId", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"https://canvas.instructure.com/lti/submission_type", "type"=>"object", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
454
|
+
"UPDATE_LINE_ITEM" => { uri: ->(course_id:, id:) { "/lti/courses/#{course_id}/line_items/#{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"=>"scoreMaximum", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"label", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resourceId", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tag", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
455
|
+
"SHOW_LINE_ITEM" => { uri: ->(course_id:, id:) { "/lti/courses/#{course_id}/line_items/#{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}] },
|
|
456
|
+
"LIST_LINE_ITEMS" => { uri: ->(course_id:) { "/lti/courses/#{course_id}/line_items" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"tag", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"resource_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"resource_link_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"limit", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
457
|
+
"DELETE_LINE_ITEM" => { uri: ->(course_id:, id:) { "/lti/courses/#{course_id}/line_items/#{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}] },
|
|
435
458
|
"CREATE_LIVE_ASSESSMENT_RESULTS" => { uri: ->(course_id:, assessment_id:) { "courses/#{course_id}/live_assessments/#{assessment_id}/results" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assessment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
436
459
|
"LIST_LIVE_ASSESSMENT_RESULTS" => { uri: ->(course_id:, assessment_id:) { "courses/#{course_id}/live_assessments/#{assessment_id}/results" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assessment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"user_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
437
460
|
"CREATE_OR_FIND_LIVE_ASSESSMENT" => { uri: ->(course_id:) { "courses/#{course_id}/live_assessments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -463,6 +486,8 @@ module LMS
|
|
|
463
486
|
"MARK_MODULE_ITEM_AS_DONE_NOT_DONE" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}/done" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
464
487
|
"GET_MODULE_ITEM_SEQUENCE" => { uri: ->(course_id:) { "courses/#{course_id}/module_item_sequence" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"asset_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["ModuleItem", "File", "Page", "Discussion", "Assignment", "Quiz", "ExternalTool"]}, {"paramType"=>"query", "name"=>"asset_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
465
488
|
"MARK_MODULE_ITEM_READ" => { uri: ->(course_id:, module_id:, id:) { "courses/#{course_id}/modules/#{module_id}/items/#{id}/mark_read" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"module_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
489
|
+
"LIST_COURSE_MEMBERSHIPS" => { uri: ->(course_id:) { "/lti/courses/#{course_id}/names_and_roles" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"rlid", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"limit", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
490
|
+
"NAMES_AND_ROLE_LIST_GROUP_MEMBERSHIPS" => { uri: ->(group_id:) { "/lti/groups/#{group_id}/names_and_roles" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"`rlid`", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"limit", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
466
491
|
"LIST_PREFERENCES_COMMUNICATION_CHANNEL_ID" => { uri: ->(user_id:, communication_channel_id:) { "users/#{user_id}/communication_channels/#{communication_channel_id}/notification_preferences" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"communication_channel_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
467
492
|
"LIST_PREFERENCES_TYPE" => { uri: ->(user_id:, type:, address:) { "users/#{user_id}/communication_channels/#{type}/#{address}/notification_preferences" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"address", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
468
493
|
"LIST_OF_PREFERENCE_CATEGORIES" => { uri: ->(user_id:, communication_channel_id:) { "users/#{user_id}/communication_channels/#{communication_channel_id}/notification_preference_categories" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"communication_channel_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -473,9 +498,9 @@ module LMS
|
|
|
473
498
|
"UPDATE_PREFERENCES_BY_CATEGORY" => { uri: ->(communication_channel_id:, category:) { "users/self/communication_channels/#{communication_channel_id}/notification_preference_categories/#{category}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"communication_channel_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"category", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"notification_preferences[frequency]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
474
499
|
"UPDATE_MULTIPLE_PREFERENCES_COMMUNICATION_CHANNEL_ID" => { uri: ->(communication_channel_id:) { "users/self/communication_channels/#{communication_channel_id}/notification_preferences" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"communication_channel_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"notification_preferences[<X>][frequency]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
475
500
|
"UPDATE_MULTIPLE_PREFERENCES_TYPE" => { uri: ->(type:, address:) { "users/self/communication_channels/#{type}/#{address}/notification_preferences" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"type", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"address", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"notification_preferences[<X>][frequency]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
476
|
-
"CREATE_ORIGINALITY_REPORT" => { uri: ->(assignment_id:, submission_id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}/originality_report" }, method: "POST", 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}, {"paramType"=>"form", "name"=>"originality_report[file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_score]", "type"=>"number", "format"=>"float", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_type_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
477
|
-
"EDIT_ORIGINALITY_REPORT_SUBMISSIONS" => { uri: ->(assignment_id:, submission_id:, id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}/originality_report/#{id}" }, method: "PUT", 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}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_score]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_type_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
478
|
-
"EDIT_ORIGINALITY_REPORT_FILES" => { uri: ->(assignment_id:, file_id:) { "/lti/assignments/#{assignment_id}/files/#{file_id}/originality_report" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"file_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_score]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_type_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
501
|
+
"CREATE_ORIGINALITY_REPORT" => { uri: ->(assignment_id:, submission_id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}/originality_report" }, method: "POST", 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}, {"paramType"=>"form", "name"=>"originality_report[file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_score]", "type"=>"number", "format"=>"float", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_type_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[error_message]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
502
|
+
"EDIT_ORIGINALITY_REPORT_SUBMISSIONS" => { uri: ->(assignment_id:, submission_id:, id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}/originality_report/#{id}" }, method: "PUT", 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}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_score]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_type_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[error_message]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
503
|
+
"EDIT_ORIGINALITY_REPORT_FILES" => { uri: ->(assignment_id:, file_id:) { "/lti/assignments/#{assignment_id}/files/#{file_id}/originality_report" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"file_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_score]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[originality_report_file_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_type_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[tool_setting][resource_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[workflow_state]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"originality_report[error_message]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
479
504
|
"SHOW_ORIGINALITY_REPORT_SUBMISSIONS" => { uri: ->(assignment_id:, submission_id:, id:) { "/lti/assignments/#{assignment_id}/submissions/#{submission_id}/originality_report/#{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}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
480
505
|
"SHOW_ORIGINALITY_REPORT_FILES" => { uri: ->(assignment_id:, file_id:) { "/lti/assignments/#{assignment_id}/files/#{file_id}/originality_report" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"assignment_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"file_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
481
506
|
"REDIRECT_TO_ROOT_OUTCOME_GROUP_FOR_CONTEXT_GLOBAL" => { uri: ->() { "global/root_outcome_group" }, method: "GET", parameters: [] },
|
|
@@ -560,7 +585,8 @@ module LMS
|
|
|
560
585
|
"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}] },
|
|
561
586
|
"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}] },
|
|
562
587
|
"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}] },
|
|
563
|
-
"
|
|
588
|
+
"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"]}] },
|
|
589
|
+
"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"]}] },
|
|
564
590
|
"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"}}] },
|
|
565
591
|
"SHOW_PLANNER_NOTE" => { uri: ->(id:) { "planner_notes/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
566
592
|
"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}] },
|
|
@@ -595,6 +621,7 @@ module LMS
|
|
|
595
621
|
"CREATE_UPDATE_PROFICIENCY_RATINGS" => { 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"}}] },
|
|
596
622
|
"GET_PROFICIENCY_RATINGS" => { uri: ->(account_id:) { "accounts/#{account_id}/outcome_proficiency" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
597
623
|
"QUERY_PROGRESS" => { uri: ->(id:) { "progress/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
624
|
+
"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}] },
|
|
598
625
|
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_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"}}] },
|
|
599
626
|
"QUIZ_EXTENSIONS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONS" => { uri: ->(course_id:, quiz_id:) { "courses/#{course_id}/quizzes/#{quiz_id}/extensions" }, 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"=>"quiz_extensions[user_id]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"quiz_extensions[extra_attempts]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"quiz_extensions[extra_time]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"quiz_extensions[manually_unlocked]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"boolean"}}, {"paramType"=>"form", "name"=>"quiz_extensions[extend_from_now]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"quiz_extensions[extend_from_end_at]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
|
600
627
|
"GET_AVAILABLE_QUIZ_IP_FILTERS" => { uri: ->(course_id:, quiz_id:) { "courses/#{course_id}/quizzes/#{quiz_id}/ip_filters" }, method: "GET", 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}] },
|
|
@@ -635,6 +662,8 @@ module LMS
|
|
|
635
662
|
"DELETE_QUIZ" => { uri: ->(course_id:, id:) { "courses/#{course_id}/quizzes/#{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}] },
|
|
636
663
|
"REORDER_QUIZ_ITEMS" => { uri: ->(course_id:, id:) { "courses/#{course_id}/quizzes/#{id}/reorder" }, 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"=>"order[id]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"order[type]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["question", "group"], "items"=>{"type"=>"string"}}] },
|
|
637
664
|
"VALIDATE_QUIZ_ACCESS_CODE" => { uri: ->(course_id:, id:) { "courses/#{course_id}/quizzes/#{id}/validate_access_code" }, 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"=>"access_code", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
665
|
+
"SHOW_COLLECTION_OF_RESULTS" => { uri: ->(course_id:, line_item_id:) { "/lti/courses/#{course_id}/line_items/#{line_item_id}/results" }, method: "GET", 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}] },
|
|
666
|
+
"SHOW_RESULT" => { uri: ->(course_id:, line_item_id:, id:) { "/lti/courses/#{course_id}/line_items/#{line_item_id}/results/#{id}" }, method: "GET", 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"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
638
667
|
"LIST_ROLES" => { uri: ->(account_id:) { "accounts/#{account_id}/roles" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "inactive"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"show_inherited", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
639
668
|
"GET_SINGLE_ROLE" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/roles/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"role_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
640
669
|
"CREATE_NEW_ROLE" => { uri: ->(account_id:) { "accounts/#{account_id}/roles" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"label", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"base_role_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["AccountMembership", "StudentEnrollment", "TeacherEnrollment", "TaEnrollment", "ObserverEnrollment", "DesignerEnrollment"]}, {"paramType"=>"form", "name"=>"permissions[<X>][explicit]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][locked]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][applies_to_self]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][applies_to_descendants]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
@@ -642,16 +671,23 @@ module LMS
|
|
|
642
671
|
"ACTIVATE_ROLE" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/roles/#{id}/activate" }, 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}, {"paramType"=>"form", "name"=>"role_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"role", "type"=>"Deprecated", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
643
672
|
"UPDATE_ROLE" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/roles/#{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"=>"label", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][explicit]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][applies_to_self]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"permissions[<X>][applies_to_descendants]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
644
673
|
"CREATE_SINGLE_RUBRIC" => { uri: ->(course_id:) { "courses/#{course_id}/rubrics" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_association_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[free_form_criterion_comments]", "type"=>"boolean", "format"=>nil, "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[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}, {"paramType"=>"form", "name"=>"rubric[criteria]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
645
|
-
"UPDATE_SINGLE_RUBRIC" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubrics/#{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_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[free_form_criterion_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[skip_updating_points_possible]", "type"=>"boolean", "format"=>nil, "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[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}, {"paramType"=>"form", "name"=>"rubric[criteria]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
674
|
+
"UPDATE_SINGLE_RUBRIC" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubrics/#{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_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[title]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[free_form_criterion_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric[skip_updating_points_possible]", "type"=>"boolean", "format"=>nil, "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[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[criteria]", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
675
|
+
"DELETE_SINGLE_RUBRIC" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubrics/#{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}] },
|
|
646
676
|
"LIST_RUBRICS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/rubrics" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
647
677
|
"LIST_RUBRICS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/rubrics" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
648
|
-
"GET_SINGLE_RUBRIC_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/rubrics/#{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"=>"
|
|
649
|
-
"GET_SINGLE_RUBRIC_COURSES" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubrics/#{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"=>"
|
|
678
|
+
"GET_SINGLE_RUBRIC_ACCOUNTS" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/rubrics/#{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"=>["assessments", "graded_assessments", "peer_assessments", "associations", "assignment_associations", "course_associations", "account_associations"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"style", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["full", "comments_only"]}] },
|
|
679
|
+
"GET_SINGLE_RUBRIC_COURSES" => { uri: ->(course_id:, id:) { "courses/#{course_id}/rubrics/#{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"=>["assessments", "graded_assessments", "peer_assessments", "associations", "assignment_associations", "course_associations", "account_associations"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"style", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["full", "comments_only"]}] },
|
|
680
|
+
"CREATE_SINGLE_RUBRIC_ASSESSMENT" => { uri: ->(course_id:, rubric_association_id:) { "courses/#{course_id}/rubric_associations/#{rubric_association_id}/rubric_assessments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"rubric_association_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"provisional", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"final", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"graded_anonymously", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
681
|
+
"UPDATE_SINGLE_RUBRIC_ASSESSMENT" => { uri: ->(course_id:, rubric_association_id:, id:) { "courses/#{course_id}/rubric_associations/#{rubric_association_id}/rubric_assessments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"course_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"rubric_association_id", "type"=>"integer", "format"=>"int64", "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"provisional", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"final", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"graded_anonymously", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rubric_assessment", "type"=>"Hash", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
682
|
+
"DELETE_SINGLE_RUBRIC_ASSESSMENT" => { uri: ->(course_id:, rubric_association_id:, id:) { "courses/#{course_id}/rubric_associations/#{rubric_association_id}/rubric_assessments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"rubric_association_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
683
|
+
"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}] },
|
|
684
|
+
"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}] },
|
|
685
|
+
"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}] },
|
|
650
686
|
"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}] },
|
|
651
687
|
"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}] },
|
|
652
688
|
"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"}}] },
|
|
653
689
|
"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}] },
|
|
654
|
-
"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}] },
|
|
690
|
+
"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}] },
|
|
655
691
|
"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}] },
|
|
656
692
|
"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}] },
|
|
657
693
|
"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}] },
|
|
@@ -659,6 +695,7 @@ module LMS
|
|
|
659
695
|
"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"]}] },
|
|
660
696
|
"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"]}] },
|
|
661
697
|
"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}] },
|
|
698
|
+
"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}] },
|
|
662
699
|
"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"}}] },
|
|
663
700
|
"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"}}] },
|
|
664
701
|
"LIST_ALL_COURSES" => { uri: ->() { "search/all_courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"search", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"public_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"open_enrollment_only", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
@@ -676,14 +713,14 @@ module LMS
|
|
|
676
713
|
"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}] },
|
|
677
714
|
"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}] },
|
|
678
715
|
"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}] },
|
|
679
|
-
"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"]}] },
|
|
680
|
-
"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"]}] },
|
|
716
|
+
"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}] },
|
|
717
|
+
"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}] },
|
|
681
718
|
"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}] },
|
|
682
719
|
"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}] },
|
|
683
720
|
"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"}}] },
|
|
684
721
|
"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"}}] },
|
|
685
|
-
"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", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
|
686
|
-
"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", "visibility", "course", "user"], "items"=>{"type"=>"string"}}] },
|
|
722
|
+
"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"}}] },
|
|
723
|
+
"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"}}] },
|
|
687
724
|
"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}] },
|
|
688
725
|
"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}] },
|
|
689
726
|
"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}] },
|
|
@@ -700,15 +737,17 @@ module LMS
|
|
|
700
737
|
"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}] },
|
|
701
738
|
"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}] },
|
|
702
739
|
"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}] },
|
|
703
|
-
"
|
|
704
|
-
"
|
|
740
|
+
"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}] },
|
|
741
|
+
"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}] },
|
|
742
|
+
"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}] },
|
|
743
|
+
"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}] },
|
|
705
744
|
"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}] },
|
|
706
745
|
"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"}}] },
|
|
707
746
|
"ADD_OBSERVEE_WITH_CREDENTIALS" => { uri: ->(user_id:) { "users/#{user_id}/observees" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"observee[unique_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"observee[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"access_token", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pairing_code", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"root_account_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
708
747
|
"SHOW_OBSERVEE" => { uri: ->(user_id:, observee_id:) { "users/#{user_id}/observees/#{observee_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"observee_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
709
748
|
"ADD_OBSERVEE" => { uri: ->(user_id:, observee_id:) { "users/#{user_id}/observees/#{observee_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"observee_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"root_account_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
710
749
|
"REMOVE_OBSERVEE" => { uri: ->(user_id:, observee_id:) { "users/#{user_id}/observees/#{observee_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"observee_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"root_account_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
711
|
-
"LIST_USERS_IN_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/users" }, 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"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["username", "email", "sis_id", "last_login"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
750
|
+
"LIST_USERS_IN_ACCOUNT" => { uri: ->(account_id:) { "accounts/#{account_id}/users" }, 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"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["username", "email", "sis_id", "last_login"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}] },
|
|
712
751
|
"LIST_ACTIVITY_STREAM_SELF" => { uri: ->() { "users/self/activity_stream" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"only_active_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
713
752
|
"LIST_ACTIVITY_STREAM_ACTIVITY_STREAM" => { uri: ->() { "users/activity_stream" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"only_active_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
714
753
|
"ACTIVITY_STREAM_SUMMARY" => { uri: ->() { "users/self/activity_stream/summary" }, method: "GET", parameters: [] },
|
|
@@ -719,10 +758,10 @@ module LMS
|
|
|
719
758
|
"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}] },
|
|
720
759
|
"HIDE_ALL_STREAM_ITEMS" => { uri: ->() { "users/self/activity_stream" }, method: "DELETE", parameters: [] },
|
|
721
760
|
"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}] },
|
|
722
|
-
"SHOW_USER_DETAILS" => { uri: ->(id:) { "users/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
761
|
+
"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"], "items"=>{"type"=>"string"}}] },
|
|
723
762
|
"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[birthdate]", "type"=>"Date", "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}] },
|
|
724
763
|
"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[birthdate]", "type"=>"Date", "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}] },
|
|
725
|
-
"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}] },
|
|
764
|
+
"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}] },
|
|
726
765
|
"GET_CUSTOM_COLORS" => { uri: ->(id:) { "users/#{id}/colors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
727
766
|
"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}] },
|
|
728
767
|
"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}] },
|
|
@@ -733,6 +772,7 @@ module LMS
|
|
|
733
772
|
"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}] },
|
|
734
773
|
"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}] },
|
|
735
774
|
"GET_PANDATA_EVENTS_JWT_TOKEN_AND_ITS_EXPIRATION_DATE" => { uri: ->() { "users/self/pandata_events_token" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"app_key", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
775
|
+
"GET_USERS_MOST_RECENTLY_GRADED_SUBMISSIONS" => { uri: ->(id:) { "users/#{id}/graded_submissions" }, 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"=>["assignment"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"only_current_enrollments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
736
776
|
"GET_USER_PROFILE" => { uri: ->(user_id:) { "users/#{user_id}/profile" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
737
777
|
"LIST_AVATAR_OPTIONS" => { uri: ->(user_id:) { "users/#{user_id}/avatars" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
738
778
|
"LIST_USER_PAGE_VIEWS" => { uri: ->(user_id:) { "users/#{user_id}/page_views" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_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}] },
|
|
@@ -744,7 +784,7 @@ module LMS
|
|
|
744
784
|
"SET_COURSE_NICKNAME" => { uri: ->(course_id:) { "users/self/course_nicknames/#{course_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"nickname", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
745
785
|
"REMOVE_COURSE_NICKNAME" => { uri: ->(course_id:) { "users/self/course_nicknames/#{course_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
746
786
|
"CLEAR_COURSE_NICKNAMES" => { uri: ->() { "users/self/course_nicknames" }, method: "DELETE", parameters: [] },
|
|
747
|
-
"CREATE_WEBHOOK_SUBSCRIPTION" => { uri: ->() { "/lti/subscriptions" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"
|
|
787
|
+
"CREATE_WEBHOOK_SUBSCRIPTION" => { uri: ->() { "/lti/subscriptions" }, method: "POST", parameters: [{"paramType"=>"form", "name"=>"subscription[ContextId]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"subscription[ContextType]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"subscription[EventTypes]", "type"=>"Array", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"subscription[Format]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"subscription[TransportMetadata]", "type"=>"Object", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"subscription[TransportType]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
748
788
|
"DELETE_WEBHOOK_SUBSCRIPTION" => { uri: ->(id:) { "/lti/subscriptions/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
749
789
|
"SHOW_SINGLE_WEBHOOK_SUBSCRIPTION" => { uri: ->(id:) { "/lti/subscriptions/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
750
790
|
"UPDATE_WEBHOOK_SUBSCRIPTION" => { uri: ->(id:) { "/lti/subscriptions/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -60,6 +60,7 @@ module LMS
|
|
|
60
60
|
"CREATE_CONTENT_MIGRATION_COURSES",
|
|
61
61
|
"UPDATE_CONTENT_MIGRATION_COURSES",
|
|
62
62
|
"LIST_MIGRATION_SYSTEMS_COURSES",
|
|
63
|
+
"LIST_ITEMS_FOR_SELECTIVE_IMPORT_COURSES",
|
|
63
64
|
"GET_CURRENT_SETTINGS_FOR_ACCOUNT_OR_COURSE_COURSES",
|
|
64
65
|
"ENABLE_DISABLE_OR_CLEAR_EXPLICIT_CSP_SETTING_COURSES",
|
|
65
66
|
"COURSE_AUDIT_LOG_QUERY_BY_COURSE",
|
|
@@ -70,6 +71,7 @@ module LMS
|
|
|
70
71
|
"LIST_USERS_IN_COURSE_SEARCH_USERS",
|
|
71
72
|
"LIST_RECENTLY_LOGGED_IN_STUDENTS",
|
|
72
73
|
"GET_SINGLE_USER",
|
|
74
|
+
"SEARCH_FOR_CONTENT_SHARE_USERS",
|
|
73
75
|
"COURSES_PREVIEW_PROCESSED_HTML",
|
|
74
76
|
"COURSE_ACTIVITY_STREAM",
|
|
75
77
|
"COURSE_ACTIVITY_STREAM_SUMMARY",
|
|
@@ -138,6 +140,7 @@ module LMS
|
|
|
138
140
|
"RESOLVE_PATH_COURSES",
|
|
139
141
|
"GET_FOLDER_COURSES",
|
|
140
142
|
"CREATE_FOLDER_COURSES",
|
|
143
|
+
"GET_UPLOADED_MEDIA_FOLDER_FOR_USER_COURSES",
|
|
141
144
|
"SET_USAGE_RIGHTS_COURSES",
|
|
142
145
|
"REMOVE_USAGE_RIGHTS_COURSES",
|
|
143
146
|
"LIST_LICENSES_COURSES",
|
|
@@ -156,6 +159,11 @@ module LMS
|
|
|
156
159
|
"LIST_GROUP_CATEGORIES_FOR_CONTEXT_COURSES",
|
|
157
160
|
"CREATE_GROUP_CATEGORY_COURSES",
|
|
158
161
|
"LIST_GROUPS_AVAILABLE_IN_CONTEXT_COURSES",
|
|
162
|
+
"CREATE_LINE_ITEM",
|
|
163
|
+
"UPDATE_LINE_ITEM",
|
|
164
|
+
"SHOW_LINE_ITEM",
|
|
165
|
+
"LIST_LINE_ITEMS",
|
|
166
|
+
"DELETE_LINE_ITEM",
|
|
159
167
|
"CREATE_LIVE_ASSESSMENT_RESULTS",
|
|
160
168
|
"LIST_LIVE_ASSESSMENT_RESULTS",
|
|
161
169
|
"CREATE_OR_FIND_LIVE_ASSESSMENT",
|
|
@@ -182,6 +190,7 @@ module LMS
|
|
|
182
190
|
"MARK_MODULE_ITEM_AS_DONE_NOT_DONE",
|
|
183
191
|
"GET_MODULE_ITEM_SEQUENCE",
|
|
184
192
|
"MARK_MODULE_ITEM_READ",
|
|
193
|
+
"LIST_COURSE_MEMBERSHIPS",
|
|
185
194
|
"REDIRECT_TO_ROOT_OUTCOME_GROUP_FOR_CONTEXT_COURSES",
|
|
186
195
|
"GET_ALL_OUTCOME_GROUPS_FOR_CONTEXT_COURSES",
|
|
187
196
|
"GET_ALL_OUTCOME_LINKS_FOR_CONTEXT_COURSES",
|
|
@@ -252,12 +261,22 @@ module LMS
|
|
|
252
261
|
"DELETE_QUIZ",
|
|
253
262
|
"REORDER_QUIZ_ITEMS",
|
|
254
263
|
"VALIDATE_QUIZ_ACCESS_CODE",
|
|
264
|
+
"SHOW_COLLECTION_OF_RESULTS",
|
|
265
|
+
"SHOW_RESULT",
|
|
255
266
|
"CREATE_SINGLE_RUBRIC",
|
|
256
267
|
"UPDATE_SINGLE_RUBRIC",
|
|
268
|
+
"DELETE_SINGLE_RUBRIC",
|
|
257
269
|
"LIST_RUBRICS_COURSES",
|
|
258
270
|
"GET_SINGLE_RUBRIC_COURSES",
|
|
271
|
+
"CREATE_SINGLE_RUBRIC_ASSESSMENT",
|
|
272
|
+
"UPDATE_SINGLE_RUBRIC_ASSESSMENT",
|
|
273
|
+
"DELETE_SINGLE_RUBRIC_ASSESSMENT",
|
|
274
|
+
"CREATE_RUBRICASSOCIATION",
|
|
275
|
+
"UPDATE_RUBRICASSOCIATION",
|
|
276
|
+
"DELETE_RUBRICASSOCIATION",
|
|
259
277
|
"RETRIEVE_ASSIGNMENTS_ENABLED_FOR_GRADE_EXPORT_TO_SIS_COURSES",
|
|
260
278
|
"DISABLE_ASSIGNMENTS_CURRENTLY_ENABLED_FOR_GRADE_EXPORT_TO_SIS",
|
|
279
|
+
"CREATE_SCORE",
|
|
261
280
|
"LIST_COURSE_SECTIONS",
|
|
262
281
|
"CREATE_COURSE_SECTION",
|
|
263
282
|
"GET_SECTION_INFORMATION_COURSES",
|
data/lib/lms/version.rb
CHANGED