GET api/Classes
Get a list of classes defined in the studioware account
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of ClassSummaryApiModelName | Description | Type | Additional information |
---|---|---|---|
Id |
The Studioware Id of the class |
integer |
None. |
InternalId |
The studio/business id assigned to the class |
string |
None. |
Name |
The name of the class |
string |
None. |
ClassType |
The type of class: group or private |
string |
None. |
Active |
True fales indicating if the classs is active |
boolean |
None. |
ClassImage |
The image used in the brief description of the class |
string |
None. |
OnlineEnrollment |
True/False indicating if this class is eligble for online enrollment |
boolean |
None. |
ClassBusinessPortalURL |
The URL to see this class in the business portal |
string |
None. |
Description |
The description of the class |
string |
None. |
ExtendedDescription |
The extended or full description of the class. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": 1, "InternalId": "sample string 2", "Name": "sample string 3", "ClassType": "sample string 4", "Active": true, "ClassImage": "sample string 6", "OnlineEnrollment": true, "ClassBusinessPortalURL": "sample string 8", "Description": "sample string 9", "ExtendedDescription": "sample string 10" }, { "Id": 1, "InternalId": "sample string 2", "Name": "sample string 3", "ClassType": "sample string 4", "Active": true, "ClassImage": "sample string 6", "OnlineEnrollment": true, "ClassBusinessPortalURL": "sample string 8", "Description": "sample string 9", "ExtendedDescription": "sample string 10" } ]
application/xml, text/xml
Sample:
<ArrayOfClassSummaryApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Studioware.Models.api"> <ClassSummaryApiModel> <Active>true</Active> <ClassBusinessPortalURL>sample string 8</ClassBusinessPortalURL> <ClassImage>sample string 6</ClassImage> <ClassType>sample string 4</ClassType> <Description>sample string 9</Description> <ExtendedDescription>sample string 10</ExtendedDescription> <Id>1</Id> <InternalId>sample string 2</InternalId> <Name>sample string 3</Name> <OnlineEnrollment>true</OnlineEnrollment> </ClassSummaryApiModel> <ClassSummaryApiModel> <Active>true</Active> <ClassBusinessPortalURL>sample string 8</ClassBusinessPortalURL> <ClassImage>sample string 6</ClassImage> <ClassType>sample string 4</ClassType> <Description>sample string 9</Description> <ExtendedDescription>sample string 10</ExtendedDescription> <Id>1</Id> <InternalId>sample string 2</InternalId> <Name>sample string 3</Name> <OnlineEnrollment>true</OnlineEnrollment> </ClassSummaryApiModel> </ArrayOfClassSummaryApiModel>