GET api/Classes/{id}/Sessions?OnlyActive={OnlyActive}

Load a list of scheduled dates for a class

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Id of a class

integer

Required

OnlyActive

True to only include active schedule classes, Fales to also included completed classes

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

ClassSessionsApiModel
NameDescriptionTypeAdditional information
ClassId

Studioware internal class id

integer

None.

ClassName

The name of the class

string

None.

ClassInternalId

The studio/business id assigned to the class

string

None.

OnlineEnrollment

True/False indicating if the class is available for Online Enrollment

boolean

None.

ClassBusinessPortalURL

The URL to see this class in the business portal

string

None.

Sessions

The tuition items defined for this class in priority order

Collection of ClassSessionDetailsApiModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ClassId": 1,
  "ClassName": "sample string 2",
  "ClassInternalId": "sample string 3",
  "OnlineEnrollment": true,
  "ClassBusinessPortalURL": "sample string 5",
  "Sessions": [
    {
      "SessionId": 1,
      "Active": true,
      "Status": "sample string 3",
      "EnrollBusinessPortalURL": "sample string 4",
      "StartDate": "2025-02-18T04:41:09.2756474-05:00",
      "StopDate": "2025-02-18T04:41:09.2756474-05:00",
      "Location": "sample string 7",
      "AverageDuration": 8.1,
      "Capacity": 9,
      "CurrentEnrollmentCount": 10,
      "CurrentWaitingListCount": 11,
      "InstructorList": "sample string 12"
    },
    {
      "SessionId": 1,
      "Active": true,
      "Status": "sample string 3",
      "EnrollBusinessPortalURL": "sample string 4",
      "StartDate": "2025-02-18T04:41:09.2756474-05:00",
      "StopDate": "2025-02-18T04:41:09.2756474-05:00",
      "Location": "sample string 7",
      "AverageDuration": 8.1,
      "Capacity": 9,
      "CurrentEnrollmentCount": 10,
      "CurrentWaitingListCount": 11,
      "InstructorList": "sample string 12"
    }
  ]
}

application/xml, text/xml

Sample:
<ClassSessionsApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Studioware.Models.api">
  <ClassBusinessPortalURL>sample string 5</ClassBusinessPortalURL>
  <ClassId>1</ClassId>
  <ClassInternalId>sample string 3</ClassInternalId>
  <ClassName>sample string 2</ClassName>
  <OnlineEnrollment>true</OnlineEnrollment>
  <Sessions>
    <ClassSessionDetailsApiModel>
      <Active>true</Active>
      <AverageDuration>8.1</AverageDuration>
      <Capacity>9</Capacity>
      <CurrentEnrollmentCount>10</CurrentEnrollmentCount>
      <CurrentWaitingListCount>11</CurrentWaitingListCount>
      <EnrollBusinessPortalURL>sample string 4</EnrollBusinessPortalURL>
      <InstructorList>sample string 12</InstructorList>
      <Location>sample string 7</Location>
      <SessionId>1</SessionId>
      <StartDate>2025-02-18T04:41:09.2756474-05:00</StartDate>
      <Status>sample string 3</Status>
      <StopDate>2025-02-18T04:41:09.2756474-05:00</StopDate>
    </ClassSessionDetailsApiModel>
    <ClassSessionDetailsApiModel>
      <Active>true</Active>
      <AverageDuration>8.1</AverageDuration>
      <Capacity>9</Capacity>
      <CurrentEnrollmentCount>10</CurrentEnrollmentCount>
      <CurrentWaitingListCount>11</CurrentWaitingListCount>
      <EnrollBusinessPortalURL>sample string 4</EnrollBusinessPortalURL>
      <InstructorList>sample string 12</InstructorList>
      <Location>sample string 7</Location>
      <SessionId>1</SessionId>
      <StartDate>2025-02-18T04:41:09.2756474-05:00</StartDate>
      <Status>sample string 3</Status>
      <StopDate>2025-02-18T04:41:09.2756474-05:00</StopDate>
    </ClassSessionDetailsApiModel>
  </Sessions>
</ClassSessionsApiModel>