Public Api V6 Substitute Teacher Class Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-structure/public-api-v6-substitute-teacher-class-structure.json",
  "name": "SubstituteTeacherClass",
  "description": "Implementation of the 'SubstituteTeacherClass' model. Represents a single class instance. Used in SubstituteClassTeacher endpoint.",
  "type": "object",
  "properties": {
    "ClassScheduleId": {
      "type": "int32",
      "description": "The class schedule ID of the requested class.",
      "example": 123456
    },
    "Location": {
      "$ref": "#/components/schemas/Location",
      "description": "Contains information about the location where the class is taking place."
    },
    "MaxCapacity": {
      "type": "int32",
      "description": "The total number of bookings allowed in the class.",
      "example": 1
    },
    "WebCapacity": {
      "type": "int32",
      "description": "The total number of online bookings allowed in the class.",
      "example": 1
    },
    "TotalBooked": {
      "type": "int32",
      "description": "The total number of clients who are booked into the class prior to this call being made.",
      "example": 1
    },
    "TotalBookedWaitlist": {
      "type": "int32",
      "description": "The total number of booked clients who are on the waiting list for the class prior to this call being made.",
      "example": 1
    },
    "WebBooked": {
      "type": "int32",
      "description": "The total number of bookings in the class made by online users, prior to this call being made. This property is the current number of bookings counted toward the `WebCapacity` limit.",
      "example": 1
    },
    "SemesterId": {
      "type": "int32",
      "description": "Identifies the semester assigned to this class.",
      "example": 123456
    },
    "IsCanceled": {
      "type": "boolean",
      "description": "When `true`, indicates that the class has been canceled.<br /> When `false`, indicates that the class has not been canceled and may still be bookable.",
      "example": true
    },
    "Substitute": {
      "type": "boolean",
      "description": "When `true`, indicates that the class is being taught by a substitute teacher.",
      "example": true
    },
    "Active": {
      "type": "boolean",
      "description": "When `true`, indicates that the class is being shown to clients in consumer mode.",
      "example": true
    },
    "IsWaitlistAvailable": {
      "type": "boolean",
      "description": "When `true`, indicates that the class has a waiting list and there is space available on the waiting list for another client.<br /> When `false`, indicates either that the class does not have a waiting list or there is no space available on the class waiting list.",
      "example": true
    },
    "HideCancel": {
      "type": "boolean",
      "description": "When `true`, indicates that this class is should not be shown to clients when `IsCancelled` is `true`.<br /> When `false`, indicates that this class is should be shown to clients when `IsCancelled` is `true`.<br /> This property can be ignored when the `IsCancelled` property is `false`.",
      "example": true
    },
    "Id": {
      "type": "int32",
      "description": "The unique identifier of the class.",
      "example": 123456
    },
    "IsAvailable": {
      "type": "boolean",
      "description": "When `true`, indicates that the class can be booked.<br /> When `false`, that the class cannot be booked at this time.",
      "example": true
    },
    "StartDateTime": {
      "type": "datetime",
      "description": "The date and time that this class is scheduled to start.",
      "example": "2026-05-28T14:30:00Z"
    },
    "EndDateTime": {
      "type": "datetime",
      "description": "The date and time when this class is scheduled to end.",
      "example": "2026-05-28T14:30:00Z"
    },
    "LastModifiedDateTime": {
      "type": "datetime",
      "description": "The last time the class was modified.",
      "example": "2026-05-28T14:30:00Z"
    },
    "ClassDescription": {
      "$ref": "#/components/schemas/ClassDescription",
      "description": "Contains information about this class."
    },
    "Staff": {
      "$ref": "#/components/schemas/Staff",
      "description": "Contains information about the teacher of the class."
    },
    "VirtualStreamLink": {
      "type": "string",
      "description": "The URL for the pre-recorded live stream for the class if hosted on the mindbody virtual wellness platform",
      "example": "example-value"
    }
  }
}