ClubReady Api

ClassCategoriesRequest

The following routes are available for this service:
GET	/scheduling/class-category	Retrieve a list of Class Categories available to a store or chain


export class ClassCategoryRequestDto
{
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ClassCategoryRequestDto>) { (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class ClassCategoriesRequest extends ClassCategoryRequestDto implements IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * Store Id or Chain Id is required
    */
    // @ApiMember(DataType="int", Description="Store Id or Chain Id is required", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    /**
    * Store Id or Chain Id is required
    */
    // @ApiMember(DataType="integer", Description="Store Id or Chain Id is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<ClassCategoriesRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ClassCategoriesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /scheduling/class-category HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml