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


open class GetClassScheduleRequestV2 : GetClassScheduleRequestDto(), IRestrictedApiRequest
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var FromDate:Date? = null
    var ToDate:Date? = null
    /**
    *  Id of CategoryNames to filter results by
    */
    @ApiMember(DataType="integer", Description=" Id of CategoryNames 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 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