def get_accounts(self, **kwargs):
"""
List accounts that the current user can view or manage.
Typically, students and teachers will get an empty list in
response. Only account admins can view the accounts that they
are in.
:calls: `GET /api/v1/accounts \
<https://canvas.instructure.com/doc/api/accounts.html#method.accounts.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.account.Account`
"""
return PaginatedList(Account,
self.__requester,
'GET',
'accounts',
_kwargs=combine_kwargs(**kwargs))
def get_courses(self, **kwargs):
"""
Retrieve all courses this user is enrolled in.
:calls: `GET /api/v1/users/:user_id/courses \
<https://canvas.instructure.com/doc/api/courses.html#method.courses.user_index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.course.Course`
"""
from canvasapi.course import Course
return PaginatedList(
Course,
self._requester,
'GET',
'users/{}/courses'.format(self.id),
_kwargs=combine_kwargs(**kwargs)
)
def get_course_nicknames(self, **kwargs):
"""
Return all course nicknames set by the current account.
:calls: `GET /api/v1/users/self/course_nicknames \
<https://canvas.instructure.com/doc/api/users.html#method.course_nicknames.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.course.CourseNickname`
"""
from canvasapi.course import CourseNickname
return PaginatedList(
CourseNickname,
self.__requester,
"GET",
"users/self/course_nicknames",
_kwargs=combine_kwargs(**kwargs),
)
def get_planner_notes(self, **kwargs):
"""
Retrieve the paginated list of planner notes
:calls: `GET /api/v1/planner_notes \
<https://canvas.instructure.com/doc/api/planner.html#method.planner_notes.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.planner.PlannerNote`
"""
from canvasapi.planner import PlannerNote
return PaginatedList(
PlannerNote,
self.__requester,
"GET",
"planner_notes",
_kwargs=combine_kwargs(**kwargs),
)
def get_announcements(self, **kwargs):
"""
List announcements.
:calls: `GET /api/v1/announcements \
<https://canvas.instructure.com/doc/api/announcements.html#method.announcements_api.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.discussion_topic.DiscussionTopic`
"""
from canvasapi.discussion_topic import DiscussionTopic
return PaginatedList(
DiscussionTopic,
self.__requester,
"GET",
"announcements",
_kwargs=combine_kwargs(**kwargs),
)
def get_calendar_events(self, **kwargs):
"""
List calendar events.
:calls: `GET /api/v1/calendar_events \
<https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.calendar_event.CalendarEvent`
"""
from canvasapi.calendar_event import CalendarEvent
return PaginatedList(
CalendarEvent,
self.__requester,
"GET",
"calendar_events",
_kwargs=combine_kwargs(**kwargs),
)
def get_files(self, **kwargs):
"""
Returns the paginated list of files for the group.
:calls: `GET /api/v1/groups/:group_id/files \
<https://canvas.instructure.com/doc/api/files.html#method.files.api_index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.file.File`
"""
from canvasapi.file import File
return PaginatedList(
File,
self._requester,
"GET",
"groups/{}/files".format(self.id),
_kwargs=combine_kwargs(**kwargs),
)
def get_migration_systems(self, **kwargs):
"""
Return a list of migration systems.
:calls: `GET /api/v1/users/:user_id/content_migrations/migrators \
<https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.available_migrators>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.content_migration.Migrator`
"""
from canvasapi.content_migration import Migrator
return PaginatedList(
Migrator,
self._requester,
'GET',
'users/{}/content_migrations/migrators'.format(self.id),
_kwargs=combine_kwargs(**kwargs)
)
def get_content_exports(self, **kwargs):
"""
Return a paginated list of the past and pending content export jobs for a group.
:calls: `GET /api/v1/groups/:group_id/content_exports\
<https://canvas.instructure.com/doc/api/content_exports.html#method.content_exports_api.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.content_export.ContentExport`
"""
from canvasapi.content_export import ContentExport
return PaginatedList(
ContentExport,
self._requester,
"GET",
"groups/{}/content_exports".format(self.id),
kwargs=combine_kwargs(**kwargs),
)
def get_discussion_topics(self, **kwargs):
"""
Returns the paginated list of discussion topics for this course or group.
:calls: `GET /api/v1/groups/:group_id/discussion_topics \
<https://canvas.instructure.com/doc/api/discussion_topics.html#method.discussion_topics.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.discussion_topic.DiscussionTopic`
"""
return PaginatedList(
DiscussionTopic,
self._requester,
"GET",
"groups/{}/discussion_topics".format(self.id),
{"group_id": self.id},
_kwargs=combine_kwargs(**kwargs),
)
def get_submission_peer_reviews(self, **kwargs):
"""
Get a list of all Peer Reviews this submission.
:calls: `GET /api/v1/courses/:course_id/assignments/:assignment_id/ \
submissions/:submission_id/peer_reviews \
<https://canvas.instructure.com/doc/api/peer_reviews.html#method.peer_reviews_api.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.peer_review.PeerReview`
"""
return PaginatedList(
PeerReview,
self._requester,
"GET",
"courses/{}/assignments/{}/submissions/{}/peer_reviews".format(
self.course_id, self.assignment_id, self.id),
_kwargs=combine_kwargs(**kwargs),
)
def get_authentication_events(self, **kwargs):
"""
List authentication events for a given user.
:calls: `GET /api/v1/audit/authentication/users/:user_id \
<https://canvas.instructure.com/doc/api/authentications_log.html#method.authentication_audit_api.for_user>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.authentication_event.AuthenticationEvent`
"""
from canvasapi.authentication_event import AuthenticationEvent
return PaginatedList(
AuthenticationEvent,
self._requester,
"GET",
"audit/authentication/users/{}".format(self.id),
_kwargs=combine_kwargs(**kwargs),
)
def list_blueprint_migrations(self, **kwargs):
"""
Return a paginated list of migrations for the template.
:calls: `GET api/v1/courses/:course_id/blueprint_templates/:template_id/migrations \
<https://canvas.instructure.com/doc/api/blueprint_courses.html#method.\
master_courses/master_templates.migrations_index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.blueprint.BlueprintMigration`
"""
return PaginatedList(
BlueprintMigration,
self._requester,
'GET',
'courses/{}/blueprint_templates/{}/migrations'.format(
self.course_id, self.id), {'course_id': self.course_id},
kwargs=combine_kwargs(**kwargs))
def get_unsynced_changes(self, **kwargs):
"""
Return changes made to associated courses of a blueprint course.
:calls: `GET /api/v1/courses/:course_id/blueprint_templates/:template_id/unsynced_changes \
<https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses\
/master_templates.unsynced_changes>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.blueprint.ChangeRecord`
"""
return PaginatedList(
ChangeRecord,
self._requester,
'GET',
'courses/{}/blueprint_templates/{}/unsynced_changes'.format(
self.course_id, self.id),
kwargs=combine_kwargs(**kwargs))
def get_licenses(self, **kwargs):
"""
Returns a paginated list of the licenses that can be applied to the
files under the group scope
:calls: `GET /api/v1/groups/:group_id/content_licenses \
<https://canvas.instructure.com/doc/api/files.html#method.usage_rights.licenses>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.license.License`
"""
return PaginatedList(
License,
self._requester,
"GET",
"groups/{}/content_licenses".format(self.id),
_kwargs=combine_kwargs(**kwargs),
)
def get_missing_submissions(self):
"""
Retrieve all past-due assignments for which the student does not
have a submission.
:calls: `GET /api/v1/users/:user_id/missing_submissions \
<https://canvas.instructure.com/doc/api/users.html#method.users.missing_submissions>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.assignment.Assignment`
"""
from canvasapi.assignment import Assignment
return PaginatedList(
Assignment,
self._requester,
'GET',
'users/{}/missing_submissions'.format(self.id)
)
def get_tabs(self, **kwargs):
"""
List available tabs for a group.
Returns a list of navigation tabs available in the current context.
:calls: `GET /api/v1/groups/:group_id/tabs \
<https://canvas.instructure.com/doc/api/tabs.html#method.tabs.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.tab.Tab`
"""
return PaginatedList(
Tab,
self._requester,
"GET",
"groups/{}/tabs".format(self.id),
{"group_id": self.id},
_kwargs=combine_kwargs(**kwargs),
)
def get_revisions(self, **kwargs):
"""
List the revisions of a page.
:calls: `GET /api/v1/courses/:course_id/pages/:url/revisions \
<https://canvas.instructure.com/doc/api/pages.html#method.wiki_pages_api.revisions>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.pagerevision.PageRevision`
"""
return PaginatedList(
PageRevision,
self._requester,
"GET",
"{}s/{}/pages/{}/revisions".format(
self.parent_type, self.parent_id, self.url
),
_kwargs=combine_kwargs(**kwargs),
)
def get_users(self, **kwargs):
"""
List users in a group.
:calls: `GET /api/v1/groups/:group_id/users \
<https://canvas.instructure.com/doc/api/groups.html#method.groups.users>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.user.User`
"""
from canvasapi.user import User
return PaginatedList(
User,
self._requester,
"GET",
"groups/{}/users".format(self.id),
_kwargs=combine_kwargs(**kwargs),
)
def get_appointment_groups(self, **kwargs):
"""
List appointment groups.
:calls: `GET /api/v1/appointment_groups \
<https://canvas.instructure.com/doc/api/appointment_groups.html#method.appointment_groups.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.appointment_group.AppointmentGroup`
"""
from canvasapi.appointment_group import AppointmentGroup
return PaginatedList(
AppointmentGroup,
self.__requester,
"GET",
"appointment_groups",
_kwargs=combine_kwargs(**kwargs),
)
def get_enrollments(self, **kwargs):
"""
List all of the enrollments for this user.
:calls: `GET /api/v1/users/:user_id/enrollments \
<https://canvas.instructure.com/doc/api/enrollments.html#method.enrollments_api.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.enrollment.Enrollment`
"""
from canvasapi.enrollment import Enrollment
return PaginatedList(
Enrollment,
self._requester,
'GET',
'users/{}/enrollments'.format(self.id),
_kwargs=combine_kwargs(**kwargs)
)
def get_conversations(self, **kwargs):
"""
Return list of conversations for the current user, most resent ones first.
:calls: `GET /api/v1/conversations \
<https://canvas.instructure.com/doc/api/conversations.html#method.conversations.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of \
:class:`canvasapi.conversation.Conversation`
"""
from canvasapi.conversation import Conversation
return PaginatedList(
Conversation,
self.__requester,
"GET",
"conversations",
_kwargs=combine_kwargs(**kwargs),
)
def get_page_views(self, **kwargs):
"""
Retrieve this user's page views.
:calls: `GET /api/v1/users/:user_id/page_views \
<https://canvas.instructure.com/doc/api/users.html#method.page_views.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.course.PageView`
"""
from canvasapi.page_view import PageView
return PaginatedList(
PageView,
self._requester,
'GET',
'users/{}/page_views'.format(self.id),
_kwargs=combine_kwargs(**kwargs)
)
def get_epub_exports(self, **kwargs):
"""
Return a list of epub exports for the associated course.
:calls: `GET /api/v1/epub_exports\
<https://canvas.instructure.com/doc/api/e_pub_exports.html#method.epub_exports.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.course_epub_export.CourseEpubExport`
"""
return PaginatedList(
CourseEpubExport,
self.__requester,
"GET",
"epub_exports",
_root="courses",
kwargs=combine_kwargs(**kwargs),
)
def get_files(self, **kwargs):
"""
Returns the paginated list of files for the user.
:calls: `GET api/v1/courses/:user_id/files \
<https://canvas.instructure.com/doc/api/files.html#method.files.api_index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.file.File`
"""
from canvasapi.file import File
return PaginatedList(
File,
self._requester,
'GET',
'users/{}/files'.format(self.id),
_kwargs=combine_kwargs(**kwargs)
)
def get_planner_overrides(self, **kwargs):
"""
Retrieve a planner override for the current user
:calls: `GET /api/v1/planner/overrides \
<https://canvas.instructure.com/doc/api/planner.html#method.planner_overrides.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.planner.PlannerOverride`
"""
from canvasapi.planner import PlannerOverride
return PaginatedList(
PlannerOverride,
self.__requester,
"GET",
"planner/overrides",
_kwargs=combine_kwargs(**kwargs),
)
def get_user_logins(self, **kwargs):
"""
Given a user ID, return that user's logins for the given account.
:calls: `GET /api/v1/users/:user_id/logins \
<https://canvas.instructure.com/doc/api/logins.html#method.pseudonyms.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.login.Login`
"""
from canvasapi.login import Login
return PaginatedList(
Login,
self._requester,
'GET',
'users/{}/logins'.format(self.id),
_kwargs=combine_kwargs(**kwargs)
)
def list_subgroups(self):
"""
List subgroups.
:calls: `GET /api/v1/global/outcome_groups/:id/subgroups \
<https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups>`_
or `GET /api/v1/accounts/:account_id/outcome_groups/:id/subgroups \
<https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups>`_
or `GET /api/v1/courses/:course_id/outcome_groups/:id/subgroups \
<https://canvas.instructure.com/doc/api/outcome_groups.html#method.outcome_groups_api.subgroups>`_
:returns: Paginated List of OutcomeGroups linked to the current group.
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.outcome.OutcomeGroup`
"""
return PaginatedList(
OutcomeGroup, self._requester, 'GET',
'{}/outcome_groups/{}/subgroups'.format(self.context_ref(),
self.id))
def get_course_accounts(self):
"""
List accounts that the current user can view through their
admin course enrollments (Teacher, TA or designer enrollments).
Only returns `id`, `name`, `workflow_state`, `root_account_id`
and `parent_account_id`.
:calls: `GET /api/v1/course_accounts \
<https://canvas.instructure.com/doc/api/accounts.html#method.accounts.course_accounts>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.account.Account`
"""
return PaginatedList(
Account,
self.__requester,
'GET',
'course_accounts',
)
def get_content_migrations(self, **kwargs):
"""
List content migrations that the current account can view or manage.
:calls: `GET /api/v1/groups/:group_id/content_migrations/ \
<https://canvas.instructure.com/doc/api/content_migrations.html#method.content_migrations.index>`_
:rtype: :class:`canvasapi.paginated_list.PaginatedList` of
:class:`canvasapi.content_migration.ContentMigration`
"""
from canvasapi.content_migration import ContentMigration
return PaginatedList(
ContentMigration,
self._requester,
'GET',
'groups/{}/content_migrations'.format(self.id),
{'group_id': self.id},
_kwargs=combine_kwargs(**kwargs)
)
