Blackout Dates API
API for accessing blackout date information.
A BlackoutDate object looks like:
// Blackout dates are used to prevent scheduling assignments on a given date in
// course pacing.
{
// the ID of the blackout date
"id": 1,
// the context owning the blackout date
"context_id": 1,
"context_type": "Course",
// the start date of the blackout date
"start_date": "2022-01-01",
// the end date of the blackout date
"end_date": "2022-01-02",
// title of the blackout date
"event_title": "some title"
}
List blackout dates BlackoutDatesController#index
GET /api/v1/courses/:course_id/blackout_dates
url:GET|/api/v1/courses/:course_id/blackout_dates
GET /api/v1/accounts/:account_id/blackout_dates
url:GET|/api/v1/accounts/:account_id/blackout_dates
Returns the list of blackout dates for the current context.
Returns a list of BlackoutDate objectsGet a single blackout date BlackoutDatesController#show
GET /api/v1/courses/:course_id/blackout_dates/:id
url:GET|/api/v1/courses/:course_id/blackout_dates/:id
GET /api/v1/accounts/:account_id/blackout_dates/:id
url:GET|/api/v1/accounts/:account_id/blackout_dates/:id
Returns the blackout date with the given id.
Returns a BlackoutDate objectNew Blackout Date BlackoutDatesController#new
GET /api/v1/courses/:course_id/blackout_dates/new
url:GET|/api/v1/courses/:course_id/blackout_dates/new
GET /api/v1/accounts/:account_id/blackout_dates/new
url:GET|/api/v1/accounts/:account_id/blackout_dates/new
Initialize an unsaved Blackout Date for the given context.
Returns a BlackoutDate objectCreate Blackout Date BlackoutDatesController#create
POST /api/v1/courses/:course_id/blackout_dates
url:POST|/api/v1/courses/:course_id/blackout_dates
POST /api/v1/accounts/:account_id/blackout_dates
url:POST|/api/v1/accounts/:account_id/blackout_dates
Create a blackout date for the given context.
Request Parameters:
Parameter | Type | Description | |
---|---|---|---|
start_date | Date |
The start date of the blackout date. |
|
end_date | Date |
The end date of the blackout date. |
|
event_title | string |
The title of the blackout date. |
Update Blackout Date BlackoutDatesController#update
PUT /api/v1/courses/:course_id/blackout_dates/:id
url:PUT|/api/v1/courses/:course_id/blackout_dates/:id
PUT /api/v1/accounts/:account_id/blackout_dates/:id
url:PUT|/api/v1/accounts/:account_id/blackout_dates/:id
Update a blackout date for the given context.
Request Parameters:
Parameter | Type | Description | |
---|---|---|---|
start_date | Date |
The start date of the blackout date. |
|
end_date | Date |
The end date of the blackout date. |
|
event_title | string |
The title of the blackout date. |
Delete Blackout Date BlackoutDatesController#destroy
DELETE /api/v1/courses/:course_id/blackout_dates/:id
url:DELETE|/api/v1/courses/:course_id/blackout_dates/:id
DELETE /api/v1/accounts/:account_id/blackout_dates/:id
url:DELETE|/api/v1/accounts/:account_id/blackout_dates/:id
Delete a blackout date for the given context.
Returns a BlackoutDate objectUpdate a list of Blackout Dates BlackoutDatesController#bulk_update
PUT /api/v1/courses/:course_id/blackout_dates
url:PUT|/api/v1/courses/:course_id/blackout_dates
Create, update, and delete blackout dates to sync the db with the incoming data.
Request Parameters:
Parameter | Type | Description | |
---|---|---|---|
blackout_dates: | string |
|