Allows you to update a class.
The ID of the class to retrieve.
The internal Id of the course the class is based on
The name of the class
A short description of the class
A description of the class in HTML
The confirmation status of the class. If blank it will default to 0. Available statuses and their values are as follows:
- Scheduled = 0
- Guaranteed To Run = 1
- Cancelled = 2
- Rescheduled = 3
- Tentative = 4
- Requested = 5
- Denied = 6
- Completed = 7
The internal Id of the Organization that is running the class. If blank it will default to the API Consumer.
The internal company Id if this class is to be dedicated to a specific company
The delivery type of the class. If blank, it will default to Physical unless other values are set to conflict with that setting. If set to Physical any virtual meeting host settings will be lost. Available delivery types are as follows:
- Physical = 1
- Virtual = 2
- Mixed = 3
The internal Id of the virtual meeting host to use if a class is to be run virtually
The url of the custom virtual classroom used for the class
The internal user id of the instructor for the class
The internal user ids of all of the instructors for the class. If a PrimaryInstructorId is not provided, the first instructor in this collection will be set as primary.
The internal id of the classroom that this class will take place in
The .NET system timezone id that the class will be delivered in. If blank it will default to the organizations timezone setting. To get a complete list of supported timezones please use tzutil as timezones are constantly changing.
The minimum student enrollments for the class to be run. If blank this value will default to the setting at the API Consumer.
The maximum student enrollments allowed for the class. If blank this value will default to either the course or API Consumer settings.
Sets this class to allow students to self-enroll
This sets if this class will be displayed on the Public Schedule
This sets if you would like to disable lab access for this class
The internal id of the student survey to associate with this class. If blank this value will default to the settings at the course or API Consumer.
The setting for when the students should begin to see that the survey is available to them. The following options are available:
- Hours Before Event Ends = 0
- Hours After Event Begins = 1
The number of hours (either before the event ends, or after the event begins, depending on the setting of StudentSurveyAvailabilityStartTypeId) for when the student survey will become available. If blank it will default to the default settings of the API Consumer.
The number of days that the student survey will be available to students after the event ends. If blank it will default to the default settings of the API Consumer.
The internal id of the survey to present to instructors of the class. If blank it will default to the default settings of the course or API Consumer.
The internal id of the organization survey for the class. If blank it will default to the default settings of the course or API Consumer.
The class's external ID, usually a unique identifier from the calling system.
A collection of ClassMeetings in JSON format.
When the class meeting starts UTC (in Unix epoch time).
When the class meeting ends UTC (in Unix epoch time).
A comma separated list of int organization Ids that this class should be available to.
OK Response
Indicates the status of the API request.
- 0 = Success
- 10 = Error
- 20 = Not found
- 30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).