ClubReady Api

<back to all web services

GetClassScheduleRequestV2

The following routes are available for this service:
GET/v2/{Apikey}/club/{StoreID}/classscheduleGet Class ScheduleSpecify ToDate/FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today.

export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

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

export class GetClassScheduleRequestDto extends ApiDtoBase
{
    public FromDate?: string;
    public ToDate?: string;
    public FilterByCategoryId?: number;

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

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

export class GetClassScheduleRequestV2 extends GetClassScheduleRequestDto implements IRestrictedApiRequest
{
    public ApiKey: string;
    public StoreId?: number;
    public FromDate?: string;
    public ToDate?: string;
    /**
    *  Id of CategoryNames to filter results by
    */
    // @ApiMember(DataType="integer", Description=" Id of CategoryNames to filter results by", Name="FilterByCategoryId", ParameterType="query")
    public FilterByCategoryId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

TypeScript GetClassScheduleRequestV2 DTOs

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

HTTP + CSV

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

GET /v2/{Apikey}/club/{StoreID}/classschedule HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv