GET api/Classes/{id}
Returns the details abount the specified class
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The Id of the class |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ClassDetailApiModelName | 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. |
OnlineEnrollment |
True/False indicating if this class is eligble for online enrollment |
boolean |
None. |
ClassImage |
The image used in the brief description of the class |
string |
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. |
MinimumAge |
The minimum age required for the class |
integer |
None. |
MaximumAge |
The maximum age required for the class |
integer |
None. |
AllowDiscounts |
True/False indicating if the class allows for discounts |
boolean |
None. |
Categories |
Class categories |
Collection of string |
None. |
PrerequsiteClasses |
List of pre-requisite classes |
Collection of ClassNameApiModel |
None. |
Response Formats
application/json, text/json
{ "Id": 1, "InternalId": "sample string 2", "Name": "sample string 3", "ClassType": "sample string 4", "Active": true, "OnlineEnrollment": true, "ClassImage": "sample string 7", "ClassBusinessPortalURL": "sample string 8", "Description": "sample string 9", "ExtendedDescription": "sample string 10", "MinimumAge": 1, "MaximumAge": 1, "AllowDiscounts": true, "Categories": [ "sample string 1", "sample string 2" ], "PrerequsiteClasses": [ { "Id": 1, "InternalId": "sample string 2", "Name": "sample string 3", "OnlineEnrollment": true, "ClassBusinessPortalURL": "sample string 5" }, { "Id": 1, "InternalId": "sample string 2", "Name": "sample string 3", "OnlineEnrollment": true, "ClassBusinessPortalURL": "sample string 5" } ] }
application/xml, text/xml
<ClassDetailApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Studioware.Models.api"> <Active>true</Active> <AllowDiscounts>true</AllowDiscounts> <Categories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Categories> <ClassBusinessPortalURL>sample string 8</ClassBusinessPortalURL> <ClassImage>sample string 7</ClassImage> <ClassType>sample string 4</ClassType> <Description>sample string 9</Description> <ExtendedDescription>sample string 10</ExtendedDescription> <Id>1</Id> <InternalId>sample string 2</InternalId> <MaximumAge>1</MaximumAge> <MinimumAge>1</MinimumAge> <Name>sample string 3</Name> <OnlineEnrollment>true</OnlineEnrollment> <PrerequsiteClasses> <ClassNameApiModel> <ClassBusinessPortalURL>sample string 5</ClassBusinessPortalURL> <Id>1</Id> <InternalId>sample string 2</InternalId> <Name>sample string 3</Name> <OnlineEnrollment>true</OnlineEnrollment> </ClassNameApiModel> <ClassNameApiModel> <ClassBusinessPortalURL>sample string 5</ClassBusinessPortalURL> <Id>1</Id> <InternalId>sample string 2</InternalId> <Name>sample string 3</Name> <OnlineEnrollment>true</OnlineEnrollment> </ClassNameApiModel> </PrerequsiteClasses> </ClassDetailApiModel>