Canvas calendar API (locking & all_day)

[matthew_buckett]

Is it possible to lock calendar events created through the Canvas API? When you create an event (https://canvas.instructure.com/doc/api/calendar_events.html#method.calendar_events_api.create) you aren't able to supply a `workflow_state` parameter and from looking at the source it's not one of the permitted properties (canvas-lms/calendar_event.rb at stable · instructure/canvas-lms · GitHub ). It looks like having `workflow_state` of `locked` would prevent a user from editing the event through the UI.

Secondly, it looks like the `all_day` parameter is permitted, but this isn't documented is this the case or is `all_day` only allowed for assignment events?

[stuart_ryan]

Hi  @matthew_buckett ,

That is a great question, I will admit I have wondered similar in the past. Depending on how you find the feedback here, this could be a great feature idea to log. I could certainly see the benefit in this for use cases such as official class times/entries, centrally conducted exams and so on.

I look forward to seeing how this pans out!

Stuart

[stuart_ryan]

Hi  @matthew_buckett ,

Unfortunately it seems that this one has stumped the community. I would highly recommend logging a feature request to seek this as an option. You can then champion in the community to get other institutions interested too!

Hope that helps,

Stuart

[agschmid]

In case there is still a question about the "all day" event, I've been doing testing with the calendar api and you can add a non-assignment event as in the example below. The time is ignored when "all_day": true

{
"calendar_event":
{"context_code": "course_12345",
   "title": "Test All Day Event",
   "description": "Testing api calls for calendar events",
   "start_at": "2019-09-13T09:00:00-04:00",
   "all_day": true}
}