Grading Period Sets

Manage grading period sets

A GradingPeriodSets object looks like:

{
  // The title of the grading period set.
  "title": "Hello World",
  // If true, the grading periods in the set are weighted.
  "weighted": true,
  // If true, the totals for all grading periods in the set are displayed.
  "display_totals_for_all_grading_periods": true
}

List grading period sets

GradingPeriodSetsController#index

GET /api/v1/accounts/:account_id/grading_period_sets

Scope: url:GET|/api/v1/accounts/:account_id/grading_period_sets

Returns the paginated list of grading period sets

Example Response:

{
  "grading_period_set": [GradingPeriodGroup]
}

Create a grading period set

GradingPeriodSetsController#create

POST /api/v1/accounts/:account_id/grading_period_sets

Scope: url:POST|/api/v1/accounts/:account_id/grading_period_sets

Create and return a new grading period set

Request Parameters:

Parameter	Type	Description
enrollment_term_ids[]	Array	A list of associated term ids for the grading period set
grading_period_set[][title]	Required string	The title of the grading period set
grading_period_set[][weighted]	boolean	A boolean to determine whether the grading periods in the set are weighted
grading_period_set[][display_totals_for_all_grading_periods]	boolean	A boolean to determine whether the totals for all grading periods in the set are displayed

Example Response:

{
  "grading_period_set": [GradingPeriodGroup]
}

Update a grading period set

GradingPeriodSetsController#update

PATCH /api/v1/accounts/:account_id/grading_period_sets/:id

Scope: url:PATCH|/api/v1/accounts/:account_id/grading_period_sets/:id

Update an existing grading period set

204 No Content response code is returned if the update was successful.

Request Parameters:

Parameter	Type	Description
enrollment_term_ids[]	Array	A list of associated term ids for the grading period set
grading_period_set[][title]	Required string	The title of the grading period set
grading_period_set[][weighted]	boolean	A boolean to determine whether the grading periods in the set are weighted
grading_period_set[][display_totals_for_all_grading_periods]	boolean	A boolean to determine whether the totals for all grading periods in the set are displayed

Delete a grading period set

GradingPeriodSetsController#destroy

DELETE /api/v1/accounts/:account_id/grading_period_sets/:id

Scope: url:DELETE|/api/v1/accounts/:account_id/grading_period_sets/:id

204 No Content response code is returned if the deletion was successful.

---

© Instructure, Inc. Generated on Wed Nov 6 14:20:07 2024 This documentation is generated directly from the Canvas LMS source code, available on Github.