ClubReady Api

<back to all web services

CreateClassScheduleRequest

The following routes are available for this service:
POST/scheduling/class-scheduleCreate a Class Schedule
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateClassScheduleRequest : CreateClassScheduleRequestDto(), 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

    /**
    * Store ID
    */
    @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * Class ID
    */
    @ApiMember(DataType="integer", Description="Class ID", IsRequired=true, Name="ClassId", ParameterType="query")
    var ClassId:Int? = null

    /**
    * Date and Time for Class
    */
    @ApiMember(DataType="date-time", Description="Date and Time for Class", IsRequired=true, Name="ClassDateTime", ParameterType="query")
    var ClassDateTime:Date? = null

    /**
    * Trainer ID
    */
    @ApiMember(DataType="integer", Description="Trainer ID", Name="TrainerId", ParameterType="query")
    var TrainerId:Int? = null

    /**
    * Alternate Class Name
    */
    @ApiMember(DataType="string", Description="Alternate Class Name", Name="AlternateClassName", ParameterType="query")
    var AlternateClassName:String? = null

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

open class CreateClassScheduleRequestDto : ApiDtoBase()
{
    var ClassId:Int? = null
    var ClassDateTime:Date? = null
    var TrainerId:Int? = null
    var AlternateClassName:String? = null
}

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

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

open class CreateClassScheduleResponse : CreateClassScheduleResponseDto()
{
    var Success:Boolean? = null
    var ClassScheduleId:Int? = null
    var Message:String? = null
}

open class CreateClassScheduleResponseDto : ApiResponseBase()
{
    var ClassScheduleId:Int? = null
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

Kotlin CreateClassScheduleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /scheduling/class-schedule HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	ClassId: 0,
	ClassDateTime: 0001-01-01,
	TrainerId: 0,
	AlternateClassName: String,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	ClassScheduleId: 0,
	Message: String
}