How to Enter Overrides Using Canvas Live API

[daniel_savlon]

I am working on adding Enrollment Terms to Canvas using the API.

In the Canvas Live API, the fields exist to provide starting/ending dates for certain enrollment types, but I'm not sure how to format the string when I'm testing this in the Live API.

See the field circled in red below. How can I tell this interface that I want the end date for teachers to be 12/20/2021?

Thanks to anyone who can help.

[MikeBrinkman]

According to the API docs, the end result JSON is:
"overrides": {"StudentEnrollment":{"start_at":"2014-01-07T08:00:00-05:00","end_at":"2014-05-14T05:00:00-04:0"}}, so presumably, you could just write:

"overrides": {"TeacherEnrollment":{"end_at":"2021-12-20T05:00:00-04:0"}}

in your JSON file. If that doesn't work, maybe try adding the "start_at" property with the start date for the term as well?

However, it is not clear at all from the documentation on what the text entry should be in that field. I tried several combinations and kept getting an invalid value.

[robotcars]

I haven't tried the endpoint, but the dates should be formatted:

On this page before the fold... https://canvas.instructure.com/doc/api/

With either encoding, all timestamps are sent and returned in ISO 8601 format (UTC time zone):

YYYY-MM-DDTHH:MM:SSZ

Edit:

https://canvas.instructure.com/doc/api/enrollment_terms.html#method.terms.update

The day/time the term starts. Accepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.

The day/time the term ends. Accepts times in ISO 8601 format, e.g. 2015-01-10T18:48:00Z.

[MikeBrinkman]

The problem is the override end date field expects and object, not a date (which it says at the top in the model, despite showing a DateTime in the data type column of the parameters) , so it seems as though it needs a JSON formatted string. Putting just the properly formatted date in that field generates an error.

[robotcars]

I am not sure how to format it for the field in the Live API, I vaguely recall that some of the Live API has some quirks. It referencing an Object, is due to it being an Object in the API, not necessarily passing an object through the Live API form, I could be wrong. I think the Live API  is generated as part of the same process that generates the API documentation.

I tried passing this in the LiveAPI: {"enrollment_term":{"overrides":{"student_enrollment":{"start_at":"2021-06-03T07:00:00.000Z"}}}}

and got "message": "Invalid enrollment type in overrides"

I used PAW to format a JSON request payload that I was able to confirm updated the name of the term and the override

{
  "enrollment_term": {
    "name": "K12 20-21 Summer",
    "overrides": {
      "StudentEnrollment": {
        "start_at": "2021-06-03T07:00:00.000Z",
        "end_at": "2021-07-17T07:00:00.000Z"
      }
    }
  }
}