Website : rimsha.abasa.com
backdoor
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
var
/
canvas
/
public
/
doc
/
api
/
Filename :
enrollment_terms.html
back
Copy
<!DOCTYPE html> <html> <head> <meta name="Content-Type" content="text/html;charset=UTF-8"> <meta charset="UTF-8"> <title>Enrollment Terms - Canvas LMS REST API Documentation</title> <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" /> <link href="css/prettify.css" rel="stylesheet" type="text/css" media="screen" /> <script src="js/jquery.min.js" type="text/javascript"></script> <script src="js/prettify.js" type="text/javascript"></script> <script type="text/javascript"> $(function() { // set up pretty-printing in static docs generated from .md files $('pre.code.bash').addClass('prettyprint language-bash'); $('pre.code.html').addClass('prettyprint language-html'); $('pre.code.xml').addClass('prettyprint language-xml'); $('pre.code.json').addClass('prettyprint language-js'); $('pre.code.javascript').addClass('prettyprint language-js'); prettyPrint(); }); </script> </head> <body> <div id="header"> <h1> <a href="index.html">Canvas LMS - REST API and Extensions Documentation</a> </h1> </div> <div id="sidebar"> <nav> <div class="expand-all-toggle"> <input id="toggle-input" type="checkbox" onClick="toggle(this)"> <label for="toggle-input" class="toggle-label">Expand all</label> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-basics" type="checkbox" > <label class="ac-label" for="sidebar-basics">Basics</label> <div class="ac-text"> <div class="ac-sub"> <a class="" href="file.graphql.html">GraphQL</a><a class="" href="file.changelog.html">API Change Log</a><a class="" href="file.object_ids.html">SIS IDs</a><a class="" href="file.pagination.html">Pagination</a><a class="" href="file.throttling.html">Throttling</a><a class="" href="file.compound_documents.html">Compound Documents</a><a class="" href="file.file_uploads.html">File Uploads</a><a class="" href="file.endpoint_attributes.html">API Endpoint Attributes</a><a class="" href="file.masquerading.html">Masquerading</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-oauth2" type="checkbox" > <label class="ac-label" for="sidebar-oauth2">OAuth2</label> <div class="ac-text"> <div class="ac-sub"> <a class="" href="file.oauth.html">OAuth2 Overview</a><a class="" href="file.oauth_endpoints.html">OAuth2 Endpoints</a><a class="" href="file.developer_keys.html">Developer Keys</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-resources" type="checkbox" checked > <label class="ac-label" for="sidebar-resources">Resources</label> <div class="ac-text"> <div class="ac-sub"> <a href="all_resources.html" class="">All Resources Reference</a> <a class="" href="access_tokens.html">Access Tokens</a> <a class="" href="account_calendars.html">Account Calendars</a> <a class="" href="account_notifications.html">Account Notifications</a> <a class="" href="account_reports.html">Account Reports</a> <a class="" href="accounts.html">Accounts</a> <a class="" href="accounts_(lti).html">Accounts (LTI)</a> <a class="" href="admins.html">Admins</a> <a class="" href="announcement_external_feeds.html">Announcement External Feeds</a> <a class="" href="announcements.html">Announcements</a> <a class="" href="api_token_scopes.html">API Token Scopes</a> <a class="" href="appointment_groups.html">Appointment Groups</a> <a class="" href="assignment_extensions.html">Assignment Extensions</a> <a class="" href="assignment_groups.html">Assignment Groups</a> <a class="" href="assignments.html">Assignments</a> <a class="" href="authentication_providers.html">Authentication Providers</a> <a class="" href="authentications_log.html">Authentications Log</a> <a class="" href="blackout_dates.html">Blackout Dates</a> <a class="" href="blueprint_courses.html">Blueprint Courses</a> <a class="" href="bookmarks.html">Bookmarks</a> <a class="" href="brand_configs.html">Brand Configs</a> <a class="" href="calendar_events.html">Calendar Events</a> <a class="" href="collaborations.html">Collaborations</a> <a class="" href="comm_messages.html">CommMessages</a> <a class="" href="communication_channels.html">Communication Channels</a> <a class="" href="conferences.html">Conferences</a> <a class="" href="content_exports.html">Content Exports</a> <a class="" href="content_migrations.html">Content Migrations</a> <a class="" href="content_security_policy_settings.html">Content Security Policy Settings</a> <a class="" href="content_shares.html">Content Shares</a> <a class="" href="conversations.html">Conversations</a> <a class="" href="course_audit_log.html">Course Audit log</a> <a class="" href="course_pace.html">Course Pace</a> <a class="" href="course_quiz_extensions.html">Course Quiz Extensions</a> <a class="" href="courses.html">Courses</a> <a class="" href="custom_gradebook_columns.html">Custom Gradebook Columns</a> <a class="" href="discussion_topics.html">Discussion Topics</a> <a class="current" href="enrollment_terms.html">Enrollment Terms</a> <a class="" href="enrollments.html">Enrollments</a> <a class="" href="e_portfolios.html">ePortfolios</a> <a class="" href="e_pub_exports.html">ePub Exports</a> <a class="" href="error_reports.html">Error Reports</a> <a class="" href="external_tools.html">External Tools</a> <a class="" href="favorites.html">Favorites</a> <a class="" href="feature_flags.html">Feature Flags</a> <a class="" href="files.html">Files</a> <a class="" href="grade_change_log.html">Grade Change Log</a> <a class="" href="gradebook_history.html">Gradebook History</a> <a class="" href="grading_period_sets.html">Grading Period Sets</a> <a class="" href="grading_periods.html">Grading Periods</a> <a class="" href="grading_standards.html">Grading Standards</a> <a class="" href="group_categories.html">Group Categories</a> <a class="" href="groups.html">Groups</a> <a class="" href="history.html">History</a> <a class="" href="inst_access_tokens.html">InstAccess tokens</a> <a class="" href="jw_ts.html">JWTs</a> <a class="" href="late_policy.html">Late Policy</a> <a class="" href="learning_object_dates.html">Learning Object Dates</a> <a class="" href="line_items.html">Line Items</a> <a class="" href="live_assessments.html">LiveAssessments</a> <a class="" href="logins.html">Logins</a> <a class="" href="lti_resource_links.html">LTI Resource Links</a> <a class="" href="media_objects.html">Media Objects</a> <a class="" href="moderated_grading.html">Moderated Grading</a> <a class="" href="modules.html">Modules</a> <a class="" href="names_and_role.html">Names and Role</a> <a class="" href="notification_preferences.html">Notification Preferences</a> <a class="" href="originality_reports.html">Originality Reports</a> <a class="" href="outcome_groups.html">Outcome Groups</a> <a class="" href="outcome_imports.html">Outcome Imports</a> <a class="" href="outcome_results.html">Outcome Results</a> <a class="" href="outcomes.html">Outcomes</a> <a class="" href="pages.html">Pages</a> <a class="" href="peer_reviews.html">Peer Reviews</a> <a class="" href="planner.html">Planner</a> <a class="" href="poll_sessions.html">Poll Sessions</a> <a class="" href="poll_choices.html">PollChoices</a> <a class="" href="polls.html">Polls</a> <a class="" href="poll_submissions.html">PollSubmissions</a> <a class="" href="proficiency_ratings.html">Proficiency Ratings</a> <a class="" href="progress.html">Progress</a> <a class="" href="public_jwk.html">Public JWK</a> <a class="" href="quiz_assignment_overrides.html">Quiz Assignment Overrides</a> <a class="" href="quiz_extensions.html">Quiz Extensions</a> <a class="" href="quiz_ip_filters.html">Quiz IP Filters</a> <a class="" href="quiz_question_groups.html">Quiz Question Groups</a> <a class="" href="quiz_questions.html">Quiz Questions</a> <a class="" href="quiz_reports.html">Quiz Reports</a> <a class="" href="quiz_statistics.html">Quiz Statistics</a> <a class="" href="quiz_submission_events.html">Quiz Submission Events</a> <a class="" href="quiz_submission_files.html">Quiz Submission Files</a> <a class="" href="quiz_submission_questions.html">Quiz Submission Questions</a> <a class="" href="quiz_submission_user_list.html">Quiz Submission User List</a> <a class="" href="quiz_submissions.html">Quiz Submissions</a> <a class="" href="quizzes.html">Quizzes</a> <a class="" href="result.html">Result</a> <a class="" href="roles.html">Roles</a> <a class="" href="rubrics.html">Rubrics</a> <a class="" href="score.html">Score</a> <a class="" href="search.html">Search</a> <a class="" href="sections.html">Sections</a> <a class="" href="services.html">Services</a> <a class="" href="shared_brand_configs.html">Shared Brand Configs</a> <a class="" href="sis_import_errors.html">SIS Import Errors</a> <a class="" href="sis_imports.html">SIS Imports</a> <a class="" href="sis_integration.html">SIS Integration</a> <a class="" href="smart_search.html">Smart Search</a> <a class="" href="submission_comments.html">Submission Comments</a> <a class="" href="submissions.html">Submissions</a> <a class="" href="tabs.html">Tabs</a> <a class="" href="temporary_enrollment_pairings.html">Temporary Enrollment Pairings</a> <a class="" href="user_observees.html">User Observees</a> <a class="" href="users.html">Users</a> <a class="" href="what_if_grades.html">What If Grades</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-outcomes" type="checkbox" > <label class="ac-label" for="sidebar-outcomes">Outcomes</label> <div class="ac-text"> <div class="ac-sub"> <a href="file.outcomes_csv.html" class="">Outcomes CSV Format</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-groupCategories" type="checkbox" > <label class="ac-label" for="sidebar-groupCategories">Group Categories</label> <div class="ac-text"> <div class="ac-sub"> <a href="file.group_category_csv.html" class="">Group Categories CSV Format</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-sis" type="checkbox" > <label class="ac-label" for="sidebar-sis">SIS</label> <div class="ac-text"> <div class="ac-sub"> <a href="file.sis_csv.html" class="">SIS CSV Format</a> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-externalTools" type="checkbox" > <label class="ac-label" for="sidebar-externalTools">External Tools</label> <div class="ac-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-externalTools-lti" type="checkbox" > <label class="ac-label level1-label" for="sidebar-externalTools-lti">LTI</label> <div class="ac-sub-text"> <a class="" href="file.tools_intro.html">Introduction</a><a class="" href="file.registration.html">Registration</a><a class="" href="file.lti_dev_key_config.html">Configuring</a><a class="" href="file.tools_variable_substitutions.html">Variable Substitutions</a><a class="" href="file.content_item.html">Deep Linking</a><a class="" href="file.assignment_tools.html">Grading</a><a class="" href="file.provisioning.html">Provisioning</a><a class="" href="file.lti_window_post_message.html">PostMessage</a> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-externalTools-lti-placements" type="checkbox" > <label class="ac-label level2-label" for="sidebar-externalTools-lti-placements">Placements</label> <div class="ac-sub-text-nested"> <a class="" href="file.placements_overview.html">Placements Overview</a><a class="" href="file.navigation_tools.html">Navigation</a><a class="" href="file.homework_submission_placement.html">Homework Submission</a><a class="" href="file.editor_button_placement.html">Editor Button</a><a class="" href="file.migration_selection_placement.html">Migration Selection</a><a class="" href="file.link_selection_placement.html">Link Selection (Modules)</a><a class="" href="file.assignment_selection_placement.html">Assignment Selection</a><a class="" href="file.collaborations_placement.html">Collaborations</a> </div> </div> </div> </div> <a href="file.xapi.html" class="">xAPI</a> <a href="file.canvas_roles.html" class="">Canvas Roles</a> </div> <div class="ac-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-externalTools-plagiarism" type="checkbox" > <label class="ac-label level1-label" for="sidebar-externalTools-plagiarism">Plagiarism Detection Platform</label> <div class="ac-sub-text"> <a href="file.plagiarism_platform.html" class="">Overview</a> <a class="" href="plagiarism_detection_platform_assignments.html">Plagiarism Detection Platform Assignments</a> <a class="" href="plagiarism_detection_platform_users.html">Plagiarism Detection Platform Users</a> <a class="" href="plagiarism_detection_submissions.html">Plagiarism Detection Submissions</a> <a class="" href="webhooks_subscriptions_for_plagiarism_platform.html">Webhooks Subscriptions for Plagiarism Platform</a> <a href="file.jwt_access_tokens.html" class="">JWT Access Tokens</a> </div> </div> </div> </div> <div class="ac-container"> <input name="header" class="ac-input" id="sidebar-dataServices" type="checkbox" > <label class="ac-label" for="sidebar-dataServices">Data Services</label> <div class="ac-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents" type="checkbox" > <label class="ac-label level1-label" for="sidebar-dataServices-liveEvents">Live Events</label> <div class="ac-sub-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents-overview" type="checkbox" > <label class="ac-label level2-label" for="sidebar-dataServices-liveEvents-overview">Overview</label> <div class="ac-sub-text-nested"> <a class="" href="file.data_service_introduction.html">Introduction</a><a class="" href="file.data_service_setup.html">Setup</a><a class="" href="file.data_service_caliper_structure.html">Caliper</a><a class="" href="file.data_service_canvas_event_metadata.html">Metadata</a> </div> </div> <span class="sub-label">Event Format</span> </div> <div class="ac-sub-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents-eventFormat-canvas" type="checkbox" > <label class="ac-label level2-label" for="sidebar-dataServices-liveEvents-eventFormat-canvas">Canvas</label> <div class="ac-sub-text-nested"> <a class="" href="file.data_service_canvas_account.html">Account</a><a class="" href="file.data_service_canvas_asset.html">Asset</a><a class="" href="file.data_service_canvas_assignment.html">Assignment</a><a class="" href="file.data_service_canvas_attachment.html">Attachment</a><a class="" href="file.data_service_canvas_content.html">Content</a><a class="" href="file.data_service_canvas_conversation.html">Conversation</a><a class="" href="file.data_service_canvas_course.html">Course</a><a class="" href="file.data_service_canvas_discussion.html">Discussion</a><a class="" href="file.data_service_canvas_enrollment.html">Enrollment</a><a class="" href="file.data_service_canvas_grade.html">Grade</a><a class="" href="file.data_service_canvas_group.html">Group</a><a class="" href="file.data_service_canvas_learning.html">Learning</a><a class="" href="file.data_service_canvas_logged.html">Logged</a><a class="" href="file.data_service_canvas_module.html">Module</a><a class="" href="file.data_service_canvas_outcome.html">Outcome</a><a class="" href="file.data_service_canvas_plagiarism.html">Plagiarism</a><a class="" href="file.data_service_canvas_quiz.html">Quiz</a><a class="" href="file.data_service_canvas_rubric.html">Rubric</a><a class="" href="file.data_service_canvas_sis.html">Sis</a><a class="" href="file.data_service_canvas_submission.html">Submission</a><a class="" href="file.data_service_canvas_syllabus.html">Syllabus</a><a class="" href="file.data_service_canvas_user.html">User</a><a class="" href="file.data_service_canvas_wiki.html">Wiki</a> </div> </div> </div> <div class="ac-sub-text"> <div class="ac-sub"> <input name="header" class="ac-input" id="sidebar-dataServices-liveEvents-eventFormat-caliper" type="checkbox" > <label class="ac-label level2-label" for="sidebar-dataServices-liveEvents-eventFormat-caliper">Caliper IMS 1.1</label> <div class="ac-sub-text-nested"> <a class="" href="file.data_service_caliper_assessment.html">Assessment</a><a class="" href="file.data_service_caliper_basic.html">Basic</a><a class="" href="file.data_service_caliper_forum.html">Forum</a><a class="" href="file.data_service_caliper_grading.html">Grading</a><a class="" href="file.data_service_caliper_navigation_events.html">Navigation Events</a><a class="" href="file.data_service_caliper_session.html">Session</a> </div> </div> </div> </div> </div> </div> <div class="sidebar-trailing-background"></div> <script> function toggle(source) { let expandText = document.querySelector('label[for="toggle-input"]') let isChecked = document.querySelector('input[id="toggle-input"]').checked let checkboxes = document.querySelectorAll('input[name="header"]'); checkboxes.forEach(checkbox => { if (checkbox !== source) { checkbox.checked = source.checked } }); expandText.innerHTML = isChecked ? 'Collapse all' : 'Expand all' } </script> </nav> </div> <div id="content"><div class="service"> <h1>Enrollment Terms API</h1> <table id='quicklinks'> </table> <p>API for viewing enrollment terms. For all actions, the specified account must be a root account and the caller must have permission to manage the account (when called on non-root accounts, the errorwill be indicate the appropriate root account).</p> <div class='object_definition'> <h3><a name="EnrollmentTerm">An EnrollmentTerm object looks like:</a></h3> <pre class="example code prettyprint"><code class="language-js">{ // The unique identifier for the enrollment term. "id": 1, // The SIS id of the term. Only included if the user has permission to view SIS // information. "sis_term_id": "Sp2014", // the unique identifier for the SIS import. This field is only included if the // user has permission to manage SIS information. "sis_import_id": 34, // The name of the term. "name": "Spring 2014", // The datetime of the start of the term. "start_at": "2014-01-06T08:00:00-05:00", // The datetime of the end of the term. "end_at": "2014-05-16T05:00:00-04:00", // The state of the term. Can be 'active' or 'deleted'. "workflow_state": "active", // Term date overrides for specific enrollment types "overrides": {"StudentEnrollment":{"start_at":"2014-01-07T08:00:00-05:00","end_at":"2014-05-14T05:00:00-04:0"}}, // The number of courses in the term (available via include) "course_count": 80 }</code></pre> </div> <div class='object_definition'> <h3><a name="EnrollmentTermsList">An EnrollmentTermsList object looks like:</a></h3> <pre class="example code prettyprint"><code class="language-js">{ // a paginated list of all terms in the account "enrollment_terms": [] }</code></pre> </div> <div id="Services" class="method_details_list"> <div class="method_details first"> <h2 class='api_method_name' name='method.terms.create' data-subtopic='Enrollment Terms'> <a name='method.terms.create' href='#method.terms.create'> Create enrollment term </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/terms_controller.rb">TermsController#create</a></span> </h2> <h3 class='endpoint'> POST /api/v1/accounts/:account_id/terms </h3> <div> <strong>Scope: </strong> <code class="scope">url:POST|/api/v1/accounts/:account_id/terms</code> </div> <p>Create a new enrollment term for the specified account.</p> <h4>Request Parameters:</h4> <table class="request-params"> <thead> <tr> <th class="param-name">Parameter</th> <th class="param-req"></th> <th class="param-type">Type</th> <th class="param-desc">Description</th> </tr> </thead> <tbody> <tr class="request-param "> <td>enrollment_term[name]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The name of the term.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[start_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term starts. Accepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[end_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term ends. Accepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[sis_term_id]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The unique SIS identifier for the term.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[overrides][enrollment_type][start_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term starts, overridden for the given enrollment type. <strong>enrollment_type</strong> can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[overrides][enrollment_type][end_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term ends, overridden for the given enrollment type. <strong>enrollment_type</strong> can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment</p> </td> </tr> </tbody> </table> Returns an <a href='enrollment_terms.html#EnrollmentTerm'>EnrollmentTerm</a> object </div> <div class="method_details "> <h2 class='api_method_name' name='method.terms.update' data-subtopic='Enrollment Terms'> <a name='method.terms.update' href='#method.terms.update'> Update enrollment term </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/terms_controller.rb">TermsController#update</a></span> </h2> <h3 class='endpoint'> PUT /api/v1/accounts/:account_id/terms/:id </h3> <div> <strong>Scope: </strong> <code class="scope">url:PUT|/api/v1/accounts/:account_id/terms/:id</code> </div> <p>Update an existing enrollment term for the specified account.</p> <h4>Request Parameters:</h4> <table class="request-params"> <thead> <tr> <th class="param-name">Parameter</th> <th class="param-req"></th> <th class="param-type">Type</th> <th class="param-desc">Description</th> </tr> </thead> <tbody> <tr class="request-param "> <td>enrollment_term[name]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The name of the term.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[start_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term starts. Accepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[end_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term ends. Accepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[sis_term_id]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>The unique SIS identifier for the term.</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[overrides][enrollment_type][start_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term starts, overridden for the given enrollment type. <strong>enrollment_type</strong> can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment</p> </td> </tr> <tr class="request-param "> <td>enrollment_term[overrides][enrollment_type][end_at]</td> <td> </td> <td>DateTime</td> <td class="param-desc"> <p>The day/time the term ends, overridden for the given enrollment type. <strong>enrollment_type</strong> can be one of StudentEnrollment, TeacherEnrollment, TaEnrollment, or DesignerEnrollment</p> </td> </tr> <tr class="request-param "> <td>override_sis_stickiness</td> <td> </td> <td>boolean</td> <td class="param-desc"> <p>Default is true. If false, any fields containing “sticky” changes will not be updated. See SIS CSV Format documentation for information on which fields can have SIS stickiness</p> </td> </tr> </tbody> </table> Returns an <a href='enrollment_terms.html#EnrollmentTerm'>EnrollmentTerm</a> object </div> <div class="method_details "> <h2 class='api_method_name' name='method.terms.destroy' data-subtopic='Enrollment Terms'> <a name='method.terms.destroy' href='#method.terms.destroy'> Delete enrollment term </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/terms_controller.rb">TermsController#destroy</a></span> </h2> <h3 class='endpoint'> DELETE /api/v1/accounts/:account_id/terms/:id </h3> <div> <strong>Scope: </strong> <code class="scope">url:DELETE|/api/v1/accounts/:account_id/terms/:id</code> </div> <p>Delete the specified enrollment term.</p> Returns an <a href='enrollment_terms.html#EnrollmentTerm'>EnrollmentTerm</a> object </div> <div class="method_details "> <h2 class='api_method_name' name='method.terms_api.index' data-subtopic='Enrollment Terms'> <a name='method.terms_api.index' href='#method.terms_api.index'> List enrollment terms </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/terms_api_controller.rb">TermsApiController#index</a></span> </h2> <h3 class='endpoint'> GET /api/v1/accounts/:account_id/terms </h3> <div> <strong>Scope: </strong> <code class="scope">url:GET|/api/v1/accounts/:account_id/terms</code> </div> <p>An object with a paginated list of all of the terms in the account.</p> <h4>Request Parameters:</h4> <table class="request-params"> <thead> <tr> <th class="param-name">Parameter</th> <th class="param-req"></th> <th class="param-type">Type</th> <th class="param-desc">Description</th> </tr> </thead> <tbody> <tr class="request-param "> <td>workflow_state[]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>If set, only returns terms that are in the given state. Defaults to ‘active’.</p> <p class="param-values"> <span class="allowed">Allowed values:</span> <code class=enum>active</code>, <code class=enum>deleted</code>, <code class=enum>all</code> </p> </td> </tr> <tr class="request-param "> <td>include[]</td> <td> </td> <td>string</td> <td class="param-desc"> <p>Array of additional information to include.</p> <dl class="rdoc-list note-list"><dt>“overrides” <dd> <p>term start/end dates overridden for different enrollment types</p> </dd><dt>“course_count” <dd> <p>the number of courses in each term</p> </dd></dl> <p class="param-values"> <span class="allowed">Allowed values:</span> <code class=enum>overrides</code> </p> </td> </tr> <tr class="request-param "> <td>term_name</td> <td> </td> <td>string</td> <td class="param-desc"> <p>If set, only returns terms that match the given search keyword. Search keyword is matched against term name.</p> </td> </tr> </tbody> </table> <div class="examples"> <h4>Example Request:</h4> <h4><div class='inline'></div></h4> <pre class="example code prettyprint"><code class="language-bash">curl -H 'Authorization: Bearer <token>' \ https://<canvas>/api/v1/accounts/1/terms?include[]=overrides</code></pre> </div> <div class="examples example_response"> <h4>Example Response:</h4> <h4><div class='inline'></div></h4> <pre class="example code prettyprint"><code class="language-js">{ "enrollment_terms": [ { "id": 1, "name": "Fall 20X6" "start_at": "2026-08-31T20:00:00Z", "end_at": "2026-12-20T20:00:00Z", "created_at": "2025-01-02T03:43:11Z", "workflow_state": "active", "grading_period_group_id": 1, "sis_term_id": null, "overrides": { "StudentEnrollment": { "start_at": "2026-09-03T20:00:00Z", "end_at": "2026-12-19T20:00:00Z" }, "TeacherEnrollment": { "start_at": null, "end_at": "2026-12-30T20:00:00Z" } } } ] }</code></pre> </div> Returns an <a href='enrollment_terms.html#EnrollmentTermsList'>EnrollmentTermsList</a> object </div> <div class="method_details "> <h2 class='api_method_name' name='method.terms_api.show' data-subtopic='Enrollment Terms'> <a name='method.terms_api.show' href='#method.terms_api.show'> Retrieve enrollment term </a> <span class='defined-in'><a href="https://github.com/instructure/canvas-lms/blob/master/app/controllers/terms_api_controller.rb">TermsApiController#show</a></span> </h2> <h3 class='endpoint'> GET /api/v1/accounts/:account_id/terms/:id </h3> <div> <strong>Scope: </strong> <code class="scope">url:GET|/api/v1/accounts/:account_id/terms/:id</code> </div> <p>Retrieves the details for an enrollment term in the account. Includes overrides by default.</p> <div class="examples"> <h4>Example Request:</h4> <h4><div class='inline'></div></h4> <pre class="example code prettyprint"><code class="language-bash">curl -H 'Authorization: Bearer <token>' \ https://<canvas>/api/v1/accounts/1/terms/2</code></pre> </div> Returns an <a href='enrollment_terms.html#EnrollmentTerm'>EnrollmentTerm</a> object </div> </div> </div> </div> <script type="text/javascript"> $('h2.api_method_name').each(function(i, el) { var subtopic = $(el).data('subtopic'); var $a = $(el).find('a'); if ($.trim($a[0].innerHTML) == '') return; var $row = $('table#quicklinks tr').filter(function() { return $(this).data('subtopic') == subtopic; }); if ($row.length == 0) { $row = $('<tr/>').appendTo($('table#quicklinks')); $row.data('subtopic', subtopic); $('<th/>').append(subtopic).appendTo($row); $('<td/>').appendTo($row); } var link = $('<a/>').attr('href', '#'+$(el).attr('name')).append($.trim($a[0].innerHTML)); $row.find('td').append(link); }); </script> <div id="footer"> © Instructure, Inc. Generated on Tue Aug 27 19:26:57 2024<br> This documentation is generated directly from the Canvas LMS source code, available <a href="https://github.com/instructure/canvas-lms">on Github</a>. </div> </body> </html>