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.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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.")
    public static 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 String ApiKey = null;

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

        /**
        * 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 Date FromDate = null;

        /**
        * 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 Date ToDate = null;

        /**
        * 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 Integer FilterByCategoryId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetClassScheduleRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetClassScheduleRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Date getFromDate() { return FromDate; }
        public GetClassScheduleRequest setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public GetClassScheduleRequest setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getFilterByCategoryId() { return FilterByCategoryId; }
        public GetClassScheduleRequest setFilterByCategoryId(Integer value) { this.FilterByCategoryId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetClassScheduleRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetClassScheduleRequest 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 GetClassScheduleRequest DTOs

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