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.*


/**
* 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.")
open class GetClassScheduleRequest : GetClassScheduleRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * StoreID
    */
    @ApiMember(DataType="integer", Description="StoreID", IsRequired=true, Name="StoreID", ParameterType="query")
    var StoreId:Int? = 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")
    var FromDate:Date? = 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")
    var ToDate:Date? = 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")
    var FilterByCategoryId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class GetClassScheduleRequestDto : ApiDtoBase()
{
    var FromDate:Date? = null
    var ToDate:Date? = null
    var FilterByCategoryId:Int? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

Kotlin GetClassScheduleRequest DTOs

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