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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetClassScheduleRequestV2 extends GetClassScheduleRequestDto implements IRestrictedApiRequest
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Date FromDate = null;
        public Date ToDate = null;
        /**
        *  Id of CategoryNames to filter results by
        */
        @ApiMember(DataType="integer", Description=" Id of CategoryNames to filter results by", Name="FilterByCategoryId", ParameterType="query")
        public Integer FilterByCategoryId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetClassScheduleRequestV2 setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetClassScheduleRequestV2 setStoreId(Integer value) { this.StoreId = value; return this; }
        public Date getFromDate() { return FromDate; }
        public GetClassScheduleRequestV2 setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public GetClassScheduleRequestV2 setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getFilterByCategoryId() { return FilterByCategoryId; }
        public GetClassScheduleRequestV2 setFilterByCategoryId(Integer value) { this.FilterByCategoryId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetClassScheduleRequestV2 setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetClassScheduleRequestV2 setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetClassScheduleRequestDto extends ApiDtoBase
    {
        public Date FromDate = null;
        public Date ToDate = null;
        public Integer FilterByCategoryId = null;
        
        public Date getFromDate() { return FromDate; }
        public GetClassScheduleRequestDto setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public GetClassScheduleRequestDto setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getFilterByCategoryId() { return FilterByCategoryId; }
        public GetClassScheduleRequestDto setFilterByCategoryId(Integer value) { this.FilterByCategoryId = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java GetClassScheduleRequestV2 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 /v2/{Apikey}/club/{StoreID}/classschedule HTTP/1.1 
Host: clubready.com 
Accept: application/xml