ClubReady Api

<back to all web services

CreateClassBookingRequest

The following routes are available for this service:
POST/scheduling/class-bookingCreate a Class Booking
POST/v2/{ApiKey}/club/{StoreId}/booking(obsolete) Create a Class Booking
POST/v2/{ApiKey}/club/{StoreId}/class-booking(obsolete) Create a Class Booking
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateClassBookingRequest : CreateClassBookingRequestDto(), 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

    /**
    * UserID
    */
    @ApiMember(DataType="string", Description="UserID", IsRequired=true, Name="UserId", ParameterType="query")
    var UserId:Int? = null

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

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

    /**
    * Put user in wait list when possible
    */
    @ApiMember(DataType="bool", Description="Put user in wait list when possible", Name="AllowWaitList", ParameterType="query")
    var AllowWaitList:Boolean? = null

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

open class CreateClassBookingRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
    var ScheduleId:Int? = null
    var AllowWaitList:Boolean? = 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 CreateClassBookingResponse : CreateClassBookingResponseDto()
{
    var BookingId:Int? = null
    var Message:String? = null
}

open class CreateClassBookingResponseDto
{
    var BookingId:Int? = null
    var Message:String? = null
}

Kotlin CreateClassBookingRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /scheduling/class-booking HTTP/1.1 
Host: clubready.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ApiKey":"String","UserId":0,"StoreId":0,"ScheduleId":0,"AllowWaitList":false,"RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BookingId":0,"Message":"String"}