def put_quiz(course_id, quiz_id, post_fields, *args):
'''Edit a quiz
post_fields: - fields to post
quiz[title] : string
quiz[description] : string
quiz[quiz_type] : string
quiz[assignment_group_id] : integer
quiz[time_limit] : integer
quiz[shuffle_answers] : boolean
quiz[hide_results] : string
quiz[show_correct_answers] : boolean
quiz[show_correct_answers_last_attempt] : boolean
quiz[show_correct_answers_at] : DateTime
quiz[hide_correct_answers_at] : DateTime
quiz[allowed_attempts] : integer
quiz[scoring_policy] : string
quiz[one_question_at_a_time] : boolean
quiz[cant_go_back] : boolean
quiz[access_code] : string
quiz[ip_filter] : string
quiz[due_at] : DateTime
quiz[lock_at] : DateTime
quiz[unlock_at] : DateTime
quiz[published] : boolean
quiz[one_time_results] : boolean
quiz[only_visible_to_overrides] : boolean
'''
url_str = "courses/{}/quizzes/{}".format(course_id, quiz_id,
callhelper.args_to_params(*args))
return instance.call_api(url_str, method="PUT", post_fields=post_fields)
def put(course_id, post_fields, *args):
'''Updates a course
Keyword Arguments:
course_id - id of course
post_fields: - fields to post
course[account_id] : integer
course[name] : string
course[course_code] : string
course[start_at] : DateTime
course[end_at] : DateTime
course[license] : string
course[is_public] : boolean
course[is_public_to_auth_users] : boolean
course[public_syllabus] : boolean
course[public_syllabus_to_auth] : boolean
course[public_description] : string
course[allow_student_wiki_edits] : boolean
course[allow_wiki_comments] : boolean
course[allow_student_forum_attachments] : boolean
course[open_enrollment] : boolean
course[self_enrollment] : boolean
course[restrict_enrollments_to_course_dates] : boolean
course[term_id] : integer
course[sis_course_id] : string
course[integration_id] : string
course[hide_final_grades] : boolean
course[time_zone] : string
course[apply_assignment_group_weights] : boolean
course[storage_quota_mb] : integer
offer : boolean
course[event] : string
course[default_view] : string
course[syllabus_body] : string
course[grading_standard_id] : integer
course[course_format] : string
course[image_id] : integer
course[image_url] : string
course[remove_image] : boolean
course[blueprint] : boolean
course[blueprint_restrictions] : BlueprintRestriction
course[use_blueprint_restrictions_by_object_type] : boolean
course[blueprint_restrictions_by_object_type] : multiple BlueprintRestrictions
'''
url_str = "courses/{}{}".format(course_id,
callhelper.args_to_params(*args))
return instance.call_api(url_str, method="PUT", post_fields=post_fields)
def put(course_id, post_fields, *args):
'''Updates course settings
Keyword arguments:
course_id - id of course to update
post_fields - a dict of fields to update
- allow_student_discussion_topics : boolean
- allow_student_forum_attachments : boolean
- allow_student_discussion_editing : boolean
- allow_student_organized_groups : boolean
- hide_final_grades : boolean
- hide_distribution_graphs : boolean
- lock_all_announcements : boolean
- restrict_student_past_view : boolean
- restrict_student_future_view : boolean
- show_announcements_on_home_page : boolean
- home_page_announcement_limit : integer
'''
url_str = "courses/{}/settings{}".format(course_id,
callhelper.args_to_params(*args))
return instance.call_api(url_str, method="PUT", post_fields=post_fields)
def get(section_id, *args):
'''Get section information'''
url_str = "sections/{}{}".format(section_id,
callhelper.args_to_params(*args))
return instance.call_api(url_str)
def get_all_tools(account_id, *args):
'''List external tools'''
url_str = "accounts/{}/external_tools{}".format(
account_id, callhelper.args_to_params(*args))
return instance.all_pages(url_str)
def get(course_id, quiz_id, *args):
'''List questions in a quiz or a submission'''
url_str = "courses/{}/quizzes/{}/questions{}".format(
course_id, quiz_id, callhelper.args_to_params(*args))
return instance.all_pages(url_str)
def get_question(course_id, quiz_id, question_id, *args):
'''Get a single quiz question'''
url_str = "courses/{}/quizzes/{}/questions/{}{}".format(
course_id, quiz_id, question_id, callhelper.args_to_params(*args))
return instance.call_api(url_str)
def get(account_id, *args):
'''List enrollment terms'''
url_str = "accounts/{}/terms{}".format(account_id,
callhelper.args_to_params(*args))
return instance.all_pages(url_str)
def get(course_id, *args):
'''List files'''
url_str = "courses/{}/files{}".format(course_id, callhelper.args_to_params(*args))
return instance.all_pages(url_str)
def get(course_id, *args):
'''List users in course'''
url_str = "courses/{}/users{}".format(course_id,
callhelper.args_to_params(*args))
return CanvasAPI.instance.all_pages(url_str)
def get(user_id, *args):
'''List enrollments'''
url_str = "users/{}/enrollments{}".format(user_id,
callhelper.args_to_params(*args))
return instance.all_pages(url_str)
def get_sections(course_id, *args):
'''Gets a course'''
url_str = "courses/{}/sections{}".format(course_id,
callhelper.args_to_params(*args))
return instance.all_pages(url_str)
def get(course_id, *args):
'''List custom gradebook columns'''
url_str = "courses/{}/custom_gradebook_columns{}".format(
course_id, callhelper.args_to_params(*args))
return instance.call_api(url_str)
def get(course_id, *args):
'''Gets course settings'''
url_str = "courses/{}/settings{}".format(course_id,
callhelper.args_to_params(*args))
return instance.call_api(url_str)
def get(course_id, column_id, *args):
'''List entries for a column'''
url_str = "courses/{}/custom_gradebook_columns/{}/data{}".format(course_id, column_id, callhelper.args_to_params(*args))
return instance.call_api(url_str)
def get(user_id, *args):
'''Show user details'''
url_str = "users/{}{}".format(user_id, callhelper.args_to_params(*args))
return instance.call_api(url_str)
def get(file_id, *args):
'''Gets a course'''
url_str = "files/{}{}".format(file_id, callhelper.args_to_params(*args))
return instance.call_api(url_str)
def search(course_id, search_term, *args):
'''List users in course'''
args = ("search_term={}".format(search_term), ) + args
url_str = "courses/{}/users{}".format(course_id,
callhelper.args_to_params(*args))
return CanvasAPI.instance.call_api(url_str)
