lms-api 1.15.0 → 1.16.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 +40 -28
- data/lib/lms/course_ids_required.rb +4 -1
- data/lib/lms/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dbf4acfef5de0008c9e181c97242511e28985bc57ea09f722b3a41d5af9c0c04
|
|
4
|
+
data.tar.gz: fd7557c89ec0e9c52381f90b22c484466276f5d866be2636f7c27e0728b02fe4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8c386ae46339d2474c5056a091095b1ffe85c45f103fd0d6915fcfdcc96f21bf616bac55f42a19671ed429fada551e7942609a51dd7966cc1b79292e6a33415b
|
|
7
|
+
data.tar.gz: 110fe2f62222d994347bd82e65ab47ecfa8f116f00fef031e991cdc02bd51a6c263b9c27acb54c5698220742b44bf33c9e31d6ed85dadd176dc2bbecde3eb3e2
|
data/lib/lms/canvas_urls.rb
CHANGED
|
@@ -2,7 +2,7 @@ module LMS
|
|
|
2
2
|
CANVAS_URLs = {
|
|
3
3
|
"LIST_SCOPES" => { uri: ->(account_id:) { "accounts/#{account_id}/scopes" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"group_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["resource_name"]}] },
|
|
4
4
|
"SEARCH_ACCOUNT_DOMAINS" => { uri: ->() { "accounts/search" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"latitude", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"longitude", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}] },
|
|
5
|
-
"INDEX_OF_ACTIVE_GLOBAL_NOTIFICATION_FOR_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/account_notifications" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
5
|
+
"INDEX_OF_ACTIVE_GLOBAL_NOTIFICATION_FOR_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/account_notifications" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include_past", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
6
6
|
"SHOW_GLOBAL_NOTIFICATION" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/account_notifications/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
7
7
|
"CLOSE_NOTIFICATION_FOR_USER" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/account_notifications/#{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}] },
|
|
8
8
|
"CREATE_GLOBAL_NOTIFICATION" => { uri: ->(account_id:) { "accounts/#{account_id}/account_notifications" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_notification[subject]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_notification[message]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_notification[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_notification[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_notification[icon]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["warning", "information", "question", "error", "calendar"]}, {"paramType"=>"form", "name"=>"account_notification_roles", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
|
@@ -19,11 +19,12 @@ 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", "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"]}] },
|
|
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"]}, {"paramType"=>"query", "name"=>"starts_before", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"ends_after", "type"=>"Date", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
23
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}] },
|
|
27
|
+
"GET_ACCOUNT" => { uri: ->(account_id:) { "/lti/accounts/#{account_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
27
28
|
"MAKE_ACCOUNT_ADMIN" => { uri: ->(account_id:) { "accounts/#{account_id}/admins" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_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"=>"role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"send_confirmation", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
28
29
|
"REMOVE_ACCOUNT_ADMIN" => { uri: ->(account_id:, user_id:) { "accounts/#{account_id}/admins/#{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}, {"paramType"=>"query", "name"=>"role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
29
30
|
"LIST_ACCOUNT_ADMINS" => { uri: ->(account_id:) { "accounts/#{account_id}/admins" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"user_id", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"[Integer]"}}] },
|
|
@@ -58,18 +59,19 @@ module LMS
|
|
|
58
59
|
"LIST_STUDENT_GROUP_PARTICIPANTS" => { uri: ->(id:) { "appointment_groups/#{id}/groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"registration_status", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["all", "registered", "registered"]}] },
|
|
59
60
|
"GET_NEXT_APPOINTMENT" => { uri: ->() { "appointment_groups/next_appointment" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"appointment_group_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
|
60
61
|
"SET_EXTENSIONS_FOR_STUDENT_ASSIGNMENT_SUBMISSIONS" => { uri: ->(course_id:, assignment_id:) { "courses/#{course_id}/assignments/#{assignment_id}/extensions" }, 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"=>"assignment_extensions[user_id]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}, {"paramType"=>"form", "name"=>"assignment_extensions[extra_attempts]", "type"=>"array", "format"=>"int64", "required"=>true, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
|
61
|
-
"LIST_ASSIGNMENT_GROUPS" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignments", "discussion_topic", "all_dates", "assignment_visibility", "overrides", "submission"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_assignment_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "discussion_topic", "wiki_page", "external_tool"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"scope_assignments_to_student", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
62
|
+
"LIST_ASSIGNMENT_GROUPS" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignments", "discussion_topic", "all_dates", "assignment_visibility", "overrides", "submission", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_assignment_submission_types", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "discussion_topic", "wiki_page", "external_tool"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"scope_assignments_to_student", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
62
63
|
"GET_ASSIGNMENT_GROUP" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "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"=>["assignments", "discussion_topic", "assignment_visibility", "submission"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"grading_period_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
63
64
|
"CREATE_ASSIGNMENT_GROUP" => { uri: ->(course_id:) { "courses/#{course_id}/assignment_groups" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"position", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"group_weight", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"sis_source_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"integration_data", "type"=>"Object", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"rules", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
64
65
|
"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
66
|
"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
67
|
"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", "due_at"]}, {"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", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
68
|
+
"LIST_ASSIGNMENTS_ASSIGNMENTS" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
69
|
+
"LIST_ASSIGNMENTS_ASSIGNMENT_GROUPS" => { uri: ->(course_id:, assignment_group_id:) { "courses/#{course_id}/assignment_groups/#{assignment_group_id}/assignments" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"assignment_group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "all_dates", "overrides", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"search_term", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"bucket", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["past", "overdue", "undated", "ungraded", "unsubmitted", "upcoming", "future"]}, {"paramType"=>"query", "name"=>"assignment_ids", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"order_by", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["position", "name", "due_at"]}, {"paramType"=>"query", "name"=>"post_to_sis", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
69
70
|
"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
|
-
"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[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[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}
|
|
71
|
+
"GET_SINGLE_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["submission", "assignment_visibility", "overrides", "observed_users", "can_edit"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"override_assignment_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"needs_grading_count_by_section", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"all_dates", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
72
|
+
"CREATE_ASSIGNMENT" => { uri: ->(course_id:) { "courses/#{course_id}/assignments" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[quiz_lti]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
73
|
+
"EDIT_ASSIGNMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/assignments/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[position]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[submission_types]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["online_quiz", "none", "on_paper", "discussion_topic", "external_tool", "online_upload", "online_text_entry", "online_url", "media_recording"], "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[allowed_extensions]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"assignment[turnitin_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[vericite_enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[turnitin_settings]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[sis_assignment_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_data]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[automatic_peer_reviews]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[notify_of_update]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[group_category_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grade_group_students_individually]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[external_tool_tag_attributes]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[points_possible]", "type"=>"number", "format"=>"float", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]}, {"paramType"=>"form", "name"=>"assignment[due_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[lock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[unlock_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_group_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[assignment_overrides]", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"$ref"=>"AssignmentOverride"}}, {"paramType"=>"form", "name"=>"assignment[only_visible_to_overrides]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[published]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[omit_from_final_grade]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[moderated_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_count]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[final_grader_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[grader_comments_visible_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_anonymous_to_graders]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[graders_names_visible_to_final_grader]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[anonymous_grading]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"assignment[allowed_attempts]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}] },
|
|
74
|
+
"BULK_UPDATE_ASSIGNMENT_DATES" => { uri: ->(course_id:) { "courses/#{course_id}/assignments/bulk_update" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
73
75
|
"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
76
|
"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
77
|
"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}] },
|
|
@@ -93,7 +95,7 @@ module LMS
|
|
|
93
95
|
"GET_BLUEPRINT_INFORMATION" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
94
96
|
"GET_ASSOCIATED_COURSE_INFORMATION" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/associated_courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
95
97
|
"UPDATE_ASSOCIATED_COURSES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/update_associations" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_ids_to_add", "type"=>"Array", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_ids_to_remove", "type"=>"Array", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
96
|
-
"BEGIN_MIGRATION_TO_PUSH_TO_ASSOCIATED_COURSES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"send_notification", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"copy_settings", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
98
|
+
"BEGIN_MIGRATION_TO_PUSH_TO_ASSOCIATED_COURSES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/migrations" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"comment", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"send_notification", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"copy_settings", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"publish_after_initial_sync", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
97
99
|
"SET_OR_REMOVE_RESTRICTIONS_ON_BLUEPRINT_COURSE_OBJECT" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/restrict_item" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"content_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["assignment", "attachment", "discussion_topic", "external_tool", "quiz", "wiki_page"]}, {"paramType"=>"form", "name"=>"content_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restricted", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrictions", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
98
100
|
"GET_UNSYNCED_CHANGES" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/unsynced_changes" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
99
101
|
"LIST_BLUEPRINT_MIGRATIONS" => { uri: ->(course_id:, template_id:) { "courses/#{course_id}/blueprint_templates/#{template_id}/migrations" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"template_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -133,6 +135,7 @@ module LMS
|
|
|
133
135
|
"DELETE_PUSH_NOTIFICATION_ENDPOINT" => { uri: ->() { "users/self/communication_channels/push" }, method: "DELETE", parameters: [] },
|
|
134
136
|
"LIST_CONFERENCES_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/conferences" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
135
137
|
"LIST_CONFERENCES_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/conferences" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
138
|
+
"LIST_CONFERENCES_FOR_CURRENT_USER" => { uri: ->() { "conferences" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
136
139
|
"LIST_CONTENT_EXPORTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/content_exports" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
137
140
|
"LIST_CONTENT_EXPORTS_GROUPS" => { uri: ->(group_id:) { "groups/#{group_id}/content_exports" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
138
141
|
"LIST_CONTENT_EXPORTS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/content_exports" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -183,10 +186,10 @@ module LMS
|
|
|
183
186
|
"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"]}] },
|
|
184
187
|
"ENABLE_DISABLE_OR_CLEAR_EXPLICIT_CSP_SETTING_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/csp_settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_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"]}] },
|
|
185
188
|
"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}] },
|
|
186
|
-
"
|
|
187
|
-
"
|
|
189
|
+
"ADD_ALLOWED_DOMAIN_TO_ACCOUNT" => { 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}] },
|
|
190
|
+
"ADD_MULTIPLE_ALLOWED_DOMAINS_TO_ACCOUNT" => { 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
191
|
"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}] },
|
|
189
|
-
"
|
|
192
|
+
"REMOVE_DOMAIN_FROM_ACCOUNT" => { 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
193
|
"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
194
|
"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
195
|
"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}] },
|
|
@@ -209,6 +212,7 @@ module LMS
|
|
|
209
212
|
"FIND_RECIPIENTS" => { uri: ->() { "conversations/find_recipients" }, method: "GET", parameters: [] },
|
|
210
213
|
"UNREAD_COUNT" => { uri: ->() { "conversations/unread_count" }, method: "GET", parameters: [] },
|
|
211
214
|
"COURSE_AUDIT_LOG_QUERY_BY_COURSE" => { uri: ->(course_id:) { "audit/course/courses/#{course_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
215
|
+
"COURSE_AUDIT_LOG_QUERY_BY_ACCOUNT" => { uri: ->(account_id:) { "audit/course/accounts/#{account_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"start_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"end_time", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
212
216
|
"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}] },
|
|
213
217
|
"LIST_YOUR_COURSES" => { uri: ->() { "courses" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["teacher", "student", "ta", "observer", "designer"]}, {"paramType"=>"query", "name"=>"enrollment_role", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_role_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}, {"paramType"=>"query", "name"=>"exclude_blueprint_courses", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}] },
|
|
214
218
|
"LIST_COURSES_FOR_USER" => { uri: ->(user_id:) { "users/#{user_id}/courses" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["needs_grading_count", "syllabus_body", "public_description", "total_scores", "current_grading_period_scores", "term", "account", "course_progress", "sections", "storage_quota_used_mb", "total_students", "passback_status", "favorites", "teachers", "observed_users", "course_image", "concluded"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"state", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["unpublished", "available", "completed", "deleted"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"enrollment_state", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["active", "invited_or_pending", "completed"]}] },
|
|
@@ -226,10 +230,11 @@ module LMS
|
|
|
226
230
|
"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}] },
|
|
227
231
|
"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"]}] },
|
|
228
232
|
"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}] },
|
|
229
|
-
"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}] },
|
|
233
|
+
"UPDATE_COURSE_SETTINGS" => { uri: ->(course_id:) { "courses/#{course_id}/settings" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_topics", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_forum_attachments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_discussion_editing", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"allow_student_organized_groups", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"filter_speed_grader_by_student_group", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_final_grades", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_distribution_graphs", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hide_sections_on_course_users_page", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"lock_all_announcements", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"usage_rights_required", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrict_student_past_view", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"restrict_student_future_view", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"show_announcements_on_home_page", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"home_page_announcement_limit", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"syllabus_course_summary", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
234
|
+
"RETURN_TEST_STUDENT_FOR_COURSE" => { uri: ->(course_id:) { "courses/#{course_id}/student_view_student" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
230
235
|
"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}] },
|
|
231
236
|
"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}] },
|
|
232
|
-
"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}] },
|
|
237
|
+
"UPDATE_COURSE" => { uri: ->(id:) { "courses/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[account_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[license]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[is_public_to_auth_users]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_syllabus_to_auth]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[public_description]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_wiki_edits]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_wiki_comments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[allow_student_forum_attachments]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[open_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[self_enrollment]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[restrict_enrollments_to_course_dates]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[term_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[sis_course_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[hide_final_grades]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[apply_assignment_group_weights]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[storage_quota_mb]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"offer", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[event]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["claim", "offer", "conclude", "delete", "undelete"]}, {"paramType"=>"form", "name"=>"course[default_view]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["feed", "wiki", "modules", "syllabus", "assignments"]}, {"paramType"=>"form", "name"=>"course[syllabus_body]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[syllabus_course_summary]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grading_standard_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[grade_passback_setting]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[course_format]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_id]", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[image_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[remove_image]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions]", "type"=>"BlueprintRestriction", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[use_blueprint_restrictions_by_object_type]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course[blueprint_restrictions_by_object_type]", "type"=>"multiple BlueprintRestrictions", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
233
238
|
"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"]}] },
|
|
234
239
|
"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}] },
|
|
235
240
|
"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"}}] },
|
|
@@ -295,12 +300,12 @@ module LMS
|
|
|
295
300
|
"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}] },
|
|
296
301
|
"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"}}] },
|
|
297
302
|
"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}] },
|
|
298
|
-
"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"}}] },
|
|
299
|
-
"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"}}] },
|
|
300
|
-
"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"}}] },
|
|
303
|
+
"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", "current_points"], "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"}}] },
|
|
304
|
+
"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", "current_points"], "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"}}] },
|
|
305
|
+
"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", "current_points"], "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"}}] },
|
|
301
306
|
"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}] },
|
|
302
|
-
"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}] },
|
|
303
|
-
"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}] },
|
|
307
|
+
"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[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "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}] },
|
|
308
|
+
"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[start_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"enrollment[end_at]", "type"=>"DateTime", "format"=>nil, "required"=>false, "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}] },
|
|
304
309
|
"CONCLUDE_DEACTIVATE_OR_DELETE_ENROLLMENT" => { uri: ->(course_id:, id:) { "courses/#{course_id}/enrollments/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"task", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["conclude", "delete", "inactivate", "deactivate"]}] },
|
|
305
310
|
"ACCEPT_COURSE_INVITATION" => { uri: ->(course_id:, id:) { "courses/#{course_id}/enrollments/#{id}/accept" }, 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}] },
|
|
306
311
|
"REJECT_COURSE_INVITATION" => { uri: ->(course_id:, id:) { "courses/#{course_id}/enrollments/#{id}/reject" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -314,8 +319,8 @@ module LMS
|
|
|
314
319
|
"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"]}] },
|
|
315
320
|
"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}] },
|
|
316
321
|
"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}] },
|
|
317
|
-
"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"=>"
|
|
318
|
-
"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"=>"
|
|
322
|
+
"CREATE_EXTERNAL_TOOL_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/external_tools" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"client_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_rce_favorite", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["disabled", "enabled"]}, {"paramType"=>"form", "name"=>"course_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[prefer_sis_email]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
323
|
+
"CREATE_EXTERNAL_TOOL_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/external_tools" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"client_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"privacy_level", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false, "enum"=>["anonymous", "name_only", "public"]}, {"paramType"=>"form", "name"=>"consumer_key", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"shared_secret", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"domain", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"icon_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"text", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"custom_fields[field_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_rce_favorite", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"account_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members", "public"]}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_home_sub_navigation[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"course_navigation[visibility]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["admins", "members"]}, {"paramType"=>"form", "name"=>"course_navigation[windowTarget]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["_blank", "_self"]}, {"paramType"=>"form", "name"=>"course_navigation[default]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["disabled", "enabled"]}, {"paramType"=>"form", "name"=>"course_navigation[display_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"editor_button[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"homework_submission[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[text]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"link_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"migration_selection[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[message_type]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"tool_configuration[prefer_sis_email]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[enabled]", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[icon_url]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_width]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"resource_selection[selection_height]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_xml", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"config_url", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"not_selectable", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"oauth_compliant", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
319
324
|
"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}] },
|
|
320
325
|
"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}] },
|
|
321
326
|
"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}] },
|
|
@@ -357,6 +362,7 @@ module LMS
|
|
|
357
362
|
"GET_FILE_USERS" => { uri: ->(user_id:, id:) { "users/#{user_id}/files/#{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}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["user"], "items"=>{"type"=>"string"}}] },
|
|
358
363
|
"UPDATE_FILE" => { uri: ->(id:) { "files/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"parent_folder_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"on_duplicate", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["overwrite", "rename"]}, {"paramType"=>"form", "name"=>"lock_at", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"unlock_at", "type"=>"DateTime", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"locked", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"hidden", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
359
364
|
"DELETE_FILE" => { uri: ->(id:) { "files/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"replace", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
365
|
+
"RESET_LINK_VERIFIER" => { uri: ->(id:) { "files/#{id}/reset_verifier" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
360
366
|
"LIST_FOLDERS" => { uri: ->(id:) { "folders/#{id}/folders" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
361
367
|
"LIST_ALL_FOLDERS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/folders" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
362
368
|
"LIST_ALL_FOLDERS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/folders" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -430,7 +436,7 @@ module LMS
|
|
|
430
436
|
"EDIT_GROUP" => { uri: ->(group_id:) { "groups/#{group_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"name", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"description", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"is_public", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"join_level", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["parent_context_auto_join", "parent_context_request", "invitation_only"]}, {"paramType"=>"form", "name"=>"avatar_id", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"storage_quota_mb", "type"=>"integer", "format"=>"int64", "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"members", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}, {"paramType"=>"form", "name"=>"sis_group_id", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
431
437
|
"DELETE_GROUP" => { uri: ->(group_id:) { "groups/#{group_id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
432
438
|
"INVITE_OTHERS_TO_GROUP" => { uri: ->(group_id:) { "groups/#{group_id}/invite" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"invitees", "type"=>"array", "format"=>nil, "required"=>true, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
|
433
|
-
"LIST_GROUP_S_USERS" => { uri: ->(group_id:) { "groups/#{group_id}/users" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_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"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url"], "items"=>{"type"=>"string"}}] },
|
|
439
|
+
"LIST_GROUP_S_USERS" => { uri: ->(group_id:) { "groups/#{group_id}/users" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_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"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url"], "items"=>{"type"=>"string"}}, {"paramType"=>"query", "name"=>"exclude_inactive", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
434
440
|
"GROUPS_UPLOAD_FILE" => { uri: ->(group_id:) { "groups/#{group_id}/files" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
435
441
|
"GROUPS_PREVIEW_PROCESSED_HTML" => { uri: ->(group_id:) { "groups/#{group_id}/preview_html" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"html", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
436
442
|
"GROUP_ACTIVITY_STREAM" => { uri: ->(group_id:) { "groups/#{group_id}/activity_stream" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"group_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -463,8 +469,10 @@ module LMS
|
|
|
463
469
|
"LIST_USER_LOGINS_ACCOUNTS" => { uri: ->(account_id:) { "accounts/#{account_id}/logins" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
464
470
|
"LIST_USER_LOGINS_USERS" => { uri: ->(user_id:) { "users/#{user_id}/logins" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
465
471
|
"CREATE_USER_LOGIN" => { uri: ->(account_id:) { "accounts/#{account_id}/logins" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
466
|
-
"EDIT_USER_LOGIN" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/logins/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
472
|
+
"EDIT_USER_LOGIN" => { uri: ->(account_id:, id:) { "accounts/#{account_id}/logins/#{id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[unique_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[password]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[sis_user_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[integration_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"login[authentication_provider_id]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
467
473
|
"DELETE_USER_LOGIN" => { uri: ->(user_id:, id:) { "users/#{user_id}/logins/#{id}" }, method: "DELETE", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
474
|
+
"LIST_MEDIA_TRACKS_FOR_MEDIA_OBJECT" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}/media_tracks" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["content", "webvtt_content", "updated_at", "created_at"], "items"=>{"type"=>"string"}}] },
|
|
475
|
+
"UPDATE_MEDIA_TRACKS" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}/media_tracks" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "items"=>{"type"=>"string"}}] },
|
|
468
476
|
"LIST_MEDIA_OBJECTS_MEDIA_OBJECTS" => { uri: ->() { "media_objects" }, method: "GET", parameters: [{"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["title", "created_at"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["sources", "tracks"], "items"=>{"type"=>"string"}}] },
|
|
469
477
|
"LIST_MEDIA_OBJECTS_COURSES" => { uri: ->(course_id:) { "courses/#{course_id}/media_objects" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"sort", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["title", "created_at"]}, {"paramType"=>"query", "name"=>"order", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["asc", "desc"]}, {"paramType"=>"query", "name"=>"exclude", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["sources", "tracks"], "items"=>{"type"=>"string"}}] },
|
|
470
478
|
"UPDATE_MEDIA_OBJECT" => { uri: ->(media_object_id:) { "media_objects/#{media_object_id}" }, method: "PUT", parameters: [{"paramType"=>"path", "name"=>"media_object_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user_entered_title", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
@@ -626,7 +634,8 @@ module LMS
|
|
|
626
634
|
"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}] },
|
|
627
635
|
"QUERY_PROGRESS" => { uri: ->(id:) { "progress/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
628
636
|
"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}] },
|
|
629
|
-
"
|
|
637
|
+
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_CLASSIC_QUIZZES" => { uri: ->(course_id:) { "courses/#{course_id}/quizzes/assignment_overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
|
638
|
+
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_NEW_QUIZZES" => { uri: ->(course_id:) { "courses/#{course_id}/new_quizzes/assignment_overrides" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"course_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"quiz_assignment_overrides[0][quiz_ids]", "type"=>"array", "format"=>"int64", "required"=>false, "deprecated"=>false, "items"=>{"type"=>"integer"}}] },
|
|
630
639
|
"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"}}] },
|
|
631
640
|
"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}] },
|
|
632
641
|
"GET_SINGLE_QUIZ_GROUP" => { uri: ->(course_id:, quiz_id:, id:) { "courses/#{course_id}/quizzes/#{quiz_id}/groups/#{id}" }, 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}, {"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
@@ -747,10 +756,13 @@ module LMS
|
|
|
747
756
|
"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}] },
|
|
748
757
|
"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}] },
|
|
749
758
|
"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"}}] },
|
|
759
|
+
"LIST_OBSERVERS" => { uri: ->(user_id:) { "users/#{user_id}/observers" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["avatar_url"], "items"=>{"type"=>"string"}}] },
|
|
750
760
|
"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}] },
|
|
751
761
|
"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}] },
|
|
762
|
+
"SHOW_OBSERVER" => { uri: ->(user_id:, observer_id:) { "users/#{user_id}/observers/#{observer_id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"path", "name"=>"observer_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
752
763
|
"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}] },
|
|
753
764
|
"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}] },
|
|
765
|
+
"CREATE_OBSERVER_PAIRING_CODE" => { uri: ->(user_id:) { "users/#{user_id}/observer_pairing_codes" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"user_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
754
766
|
"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"]}] },
|
|
755
767
|
"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}] },
|
|
756
768
|
"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}] },
|
|
@@ -762,9 +774,9 @@ module LMS
|
|
|
762
774
|
"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}] },
|
|
763
775
|
"HIDE_ALL_STREAM_ITEMS" => { uri: ->() { "users/self/activity_stream" }, method: "DELETE", parameters: [] },
|
|
764
776
|
"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}] },
|
|
765
|
-
"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"}}] },
|
|
766
|
-
"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}] },
|
|
767
|
-
"
|
|
777
|
+
"SHOW_USER_DETAILS" => { uri: ->(id:) { "users/#{id}" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"query", "name"=>"include", "type"=>"array", "format"=>nil, "required"=>false, "deprecated"=>false, "enum"=>["uuid", "last_login"], "items"=>{"type"=>"string"}}] },
|
|
778
|
+
"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}, {"paramType"=>"form", "name"=>"initial_enrollment_type", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"pairing_code[code]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
779
|
+
"DEPRECATED_SELF_REGISTER_USER" => { uri: ->(account_id:) { "accounts/#{account_id}/self_registration" }, method: "POST", parameters: [{"paramType"=>"path", "name"=>"account_id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[name]", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[short_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[sortable_name]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[time_zone]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[locale]", "type"=>"string", "format"=>nil, "required"=>false, "deprecated"=>false}, {"paramType"=>"form", "name"=>"user[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}] },
|
|
768
780
|
"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}] },
|
|
769
781
|
"GET_CUSTOM_COLORS" => { uri: ->(id:) { "users/#{id}/colors" }, method: "GET", parameters: [{"paramType"=>"path", "name"=>"id", "type"=>"string", "format"=>nil, "required"=>true, "deprecated"=>false}] },
|
|
770
782
|
"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}] },
|
|
@@ -776,7 +788,7 @@ module LMS
|
|
|
776
788
|
"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}] },
|
|
777
789
|
"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}] },
|
|
778
790
|
"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}] },
|
|
779
|
-
"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}] },
|
|
791
|
+
"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}, {"paramType"=>"query", "name"=>"only_published_assignments", "type"=>"boolean", "format"=>nil, "required"=>false, "deprecated"=>false}] },
|
|
780
792
|
"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}] },
|
|
781
793
|
"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}] },
|
|
782
794
|
"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}] },
|
|
@@ -22,6 +22,7 @@ module LMS
|
|
|
22
22
|
"GET_SINGLE_ASSIGNMENT",
|
|
23
23
|
"CREATE_ASSIGNMENT",
|
|
24
24
|
"EDIT_ASSIGNMENT",
|
|
25
|
+
"BULK_UPDATE_ASSIGNMENT_DATES",
|
|
25
26
|
"LIST_ASSIGNMENT_OVERRIDES",
|
|
26
27
|
"GET_SINGLE_ASSIGNMENT_OVERRIDE",
|
|
27
28
|
"CREATE_ASSIGNMENT_OVERRIDE",
|
|
@@ -78,6 +79,7 @@ module LMS
|
|
|
78
79
|
"COURSE_TODO_ITEMS",
|
|
79
80
|
"GET_COURSE_SETTINGS",
|
|
80
81
|
"UPDATE_COURSE_SETTINGS",
|
|
82
|
+
"RETURN_TEST_STUDENT_FOR_COURSE",
|
|
81
83
|
"RESET_COURSE",
|
|
82
84
|
"GET_EFFECTIVE_DUE_DATES",
|
|
83
85
|
"COURSES_PERMISSIONS",
|
|
@@ -226,7 +228,8 @@ module LMS
|
|
|
226
228
|
"GET_ALL_PEER_REVIEWS_COURSES_SUBMISSIONS",
|
|
227
229
|
"PEER_REVIEWS_CREATE_PEER_REVIEW_COURSES",
|
|
228
230
|
"DELETE_PEER_REVIEW_COURSES",
|
|
229
|
-
"
|
|
231
|
+
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_CLASSIC_QUIZZES",
|
|
232
|
+
"RETRIEVE_ASSIGNMENT_OVERRIDDEN_DATES_FOR_NEW_QUIZZES",
|
|
230
233
|
"QUIZ_EXTENSIONS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONS",
|
|
231
234
|
"GET_AVAILABLE_QUIZ_IP_FILTERS",
|
|
232
235
|
"GET_SINGLE_QUIZ_GROUP",
|
data/lib/lms/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lms-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.16.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Atomic Jolt
|
|
@@ -10,7 +10,7 @@ authors:
|
|
|
10
10
|
autorequire:
|
|
11
11
|
bindir: bin
|
|
12
12
|
cert_chain: []
|
|
13
|
-
date: 2020-07-
|
|
13
|
+
date: 2020-07-14 00:00:00.000000000 Z
|
|
14
14
|
dependencies:
|
|
15
15
|
- !ruby/object:Gem::Dependency
|
|
16
16
|
name: activesupport
|