|active||boolean||Yes||Indicates whether or not the class should return in any GET calls.|
|additionalStaffIdList||array||Yes||Displays staffIds for any additional staff members you add to the class so they cannot otherwise be booked for this time slot. |
|blockStaffIdList||array||Yes||Displays staffIds for any additional staff members you have added so they cannot be otherwise booked for this time slot. Whatever IDs are added to the additionalStaffIdList are automatically also added to the blockStaffIdList. The blockStaffIdList is used to automatically block off staff across child accounts in our enterprise set up model.|
|blockedStaffList||array||Yes||Displays full staff objects for any additional staff members you have added in the blockStaffIdList or additionalStaffIdList.|
|businessId||integer||Yes||Provides unique numeric ID of the business offering specified class schedule.|
|cancelReason||string||Yes||Displays any reason given for cancelling a class session.|
|changeReason||string||Yes||Displays any reason given for changing a class session.|
|Yes, on POST calls|
Provides unique numeric ID for specified class schedule.
Displays any color chosen to override class sessions on the backoffice calendar.
|coordinatorStaff||object||Yes||Displays staff object for the staff member that is listed as coordinator staff for this class. The coordinator staff's schedule is not blocked like the schedules for staff members in the additionalStaffIdList are. For more info, see Staff API page.|
|courseSession||object||If the classSchedule is assigned to a reason that is reasonType=COURSE instead of reasonType=CLASS, then the courseSession object is filled in with the session of the course set that the classSchedule represents.|
|currentCapacity||integer||Yes||Displays current number of client slots filled for specified class.|
|date||string||Yes||Displays as string representation of the date the class session is taking place. Written as YYYY-MM-DD. |
|endTime||integer||Yes||Yes||Provides the time specified class ends displayed in military format. |
|fields||array||Yes||Displays an array of any custom field objects you have added during the class schedule setup.|
|hideGuestOption||boolean||Yes||If under Settings > Client Information you have the "Additional Guests in Class Bookings" allowed, but for this specific classSchedule you do not want that option to show, set this to FALSE.|
Displays the location object assigned to the specified class session - for more info, see Locations API page.
|locationGroup||object||Yes||If you assign the class session to a specific location group, then this would be the object of that location group - for more info, see Groups API page.|
|object||Yes||If you assign the class session to a specific location super group, then this would be the object of that location super group.|
|maxCapacity||integer||Yes||Displays the maximum number of slots open for specified class session.|
|reason||object||Yes||Displays the reason object for a service connected to the specified class schedule - for more info, see Services API page.|
If the class session is an instance of a recurring class schedule, this field will contain the unique ID for that recurring class schedule.
|resource||object||Yes||Displays the resource object assigned to the specific class - for more info, see Resources API page.|
|roomNumber||string||Yes||If there is a specific room or place at the location where the class is held, this field will contain that value.|
Indicates whether or not customers who are booking will be able to see how many open slots are left in the class on the scheduler.
|staff||object||Yes||Yes||Displays the staff object for a staff member connected to specified class schedule - for more info, see Staff API page. |
|startTime||integer||Yes||Yes||Provides the time specified class session starts displayed in military format. |
|status||string||Yes||Displays the status of class session. Possible values include Open, Closed, or Cancelled.|