ClubReady Api

<back to all web services

GetClassScheduleRequest

Get a list of classes for a locations. Specify 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',
}

/**
* Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range.  Omitting dates will retrieve classes for today.
*/
// @Api(Description="Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range.  Omitting dates will retrieve classes for today.")
export class GetClassScheduleRequest extends GetClassScheduleRequestDto 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;

    /**
    * StoreID
    */
    // @ApiMember(DataType="integer", Description="StoreID", IsRequired=true, Name="StoreID", ParameterType="query")
    public StoreId: number;

    /**
    * From Date (if blank, defaults to today; format: YYYY-MM-DD)
    */
    // @ApiMember(DataType="date", Description="From Date (if blank, defaults to today; format: YYYY-MM-DD)", Name="FromDate", ParameterType="query")
    public FromDate?: string;

    /**
    * To Date (max 7 days; format: YYYY-MM-DD)
    */
    // @ApiMember(DataType="date", Description="To Date (max 7 days; format: YYYY-MM-DD)", IsRequired=true, Name="ToDate", ParameterType="query")
    public ToDate: string;

    /**
    * Id of Category Names to filter results by
    */
    // @ApiMember(DataType="int", Description="Id of Category Names to filter results by", Name="FilterByCategoryId", ParameterType="query")
    public FilterByCategoryId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

TypeScript GetClassScheduleRequest DTOs

GET /scheduling/class-schedule HTTP/1.1 
Host: clubready.com 
Accept: text/jsv