Grading Periods API
Manage grading periods
A GradingPeriod object looks like:
{
// The unique identifier for the grading period.
"id": 1023,
// The title for the grading period.
"title": "First Block",
// The start date of the grading period.
"start_date": "2014-01-07T15:04:00Z",
// The end date of the grading period.
"end_date": "2014-05-07T17:07:00Z",
// Grades can only be changed before the close date of the grading period.
"close_date": "2014-06-07T17:07:00Z",
// A weight value that contributes to the overall weight of a grading period set
// which is used to calculate how much assignments in this period contribute to
// the total grade
"weight": 33.33,
// If true, the grading period's close_date has passed.
"is_closed": true
}
List grading periods GradingPeriodsController#index
GET /api/v1/accounts/:account_id/grading_periods
url:GET|/api/v1/accounts/:account_id/grading_periods
GET /api/v1/courses/:course_id/grading_periods
url:GET|/api/v1/courses/:course_id/grading_periods
Returns the paginated list of grading periods for the current course.
Example Response:
{
"grading_periods": [GradingPeriod]
}
Get a single grading period GradingPeriodsController#show
GET /api/v1/courses/:course_id/grading_periods/:id
url:GET|/api/v1/courses/:course_id/grading_periods/:id
Returns the grading period with the given id
Example Response:
{
"grading_periods": [GradingPeriod]
}
Update a single grading period GradingPeriodsController#update
PUT /api/v1/courses/:course_id/grading_periods/:id
url:PUT|/api/v1/courses/:course_id/grading_periods/:id
Update an existing grading period.
Request Parameters:
Parameter | Type | Description | |
---|---|---|---|
grading_periods[][start_date] | Required | Date |
The date the grading period starts. |
grading_periods[][end_date] | Required | Date |
no description |
grading_periods[][weight] | number |
A weight value that contributes to the overall weight of a grading period set which is used to calculate how much assignments in this period contribute to the total grade |
Example Response:
{
"grading_periods": [GradingPeriod]
}
Delete a grading period GradingPeriodsController#destroy
DELETE /api/v1/courses/:course_id/grading_periods/:id
url:DELETE|/api/v1/courses/:course_id/grading_periods/:id
DELETE /api/v1/accounts/:account_id/grading_periods/:id
url:DELETE|/api/v1/accounts/:account_id/grading_periods/:id
204 No Content response code is returned if the deletion was successful.
Batch update grading periods GradingPeriodsController#batch_update
PATCH /api/v1/courses/:course_id/grading_periods/batch_update
url:PATCH|/api/v1/courses/:course_id/grading_periods/batch_update
PATCH /api/v1/grading_period_sets/:set_id/grading_periods/batch_update
url:PATCH|/api/v1/grading_period_sets/:set_id/grading_periods/batch_update
Update multiple grading periods
Request Parameters:
Parameter | Type | Description | |
---|---|---|---|
set_id | Required | string |
The id of the grading period set. |
grading_periods[][id] | string |
The id of the grading period. If the id parameter does not exist, a new grading period will be created. |
|
grading_periods[][title] | Required | string |
The title of the grading period. The title is required for creating a new grading period, but not for updating an existing grading period. |
grading_periods[][start_date] | Required | Date |
The date the grading period starts. The start_date is required for creating a new grading period, but not for updating an existing grading period. |
grading_periods[][end_date] | Required | Date |
The date the grading period ends. The end_date is required for creating a new grading period, but not for updating an existing grading period. |
grading_periods[][close_date] | Required | Date |
The date after which grades can no longer be changed for a grading period. The close_date is required for creating a new grading period, but not for updating an existing grading period. |
grading_periods[][weight] | number |
A weight value that contributes to the overall weight of a grading period set which is used to calculate how much assignments in this period contribute to the total grade |
Example Response:
{
"grading_periods": [GradingPeriod]
}