ClubReady Api

<back to all web services

CheckBookingStatusRequest

The following routes are available for this service:
GET/scheduling/booking-status-checkDetermine if a user can book a class.
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CheckBookingStatusRequest : CheckClassBookingStatusRequestDto(), 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

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

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

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

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

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

open class CheckClassBookingStatusRequestDto : ApiDtoBase()
{
    var ClassScheduleId:Int? = null
    var UserId:Int? = 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 CheckBookingStatusResponse : CheckBookingStatusResponseDto()
{
    var Success:Boolean? = null
    var Message:String? = null
    var CanBook:Boolean? = null
    var ConsumesCredit:Boolean? = null
    var Source:String? = null
    var AvailableCredits:Int? = null
    var IsBooked:Boolean? = null
    var IsWaitListed:Boolean? = null
    var CancelHours:Int? = null
    var LeadTime:Int? = null
    var MaxLeadTime:Int? = null
}

open class CheckBookingStatusResponseDto : ApiResponseBase()
{
    var CanBook:Boolean? = null
    var ConsumesCredit:Boolean? = null
    var Source:String? = null
    var AvailableCredits:Int? = null
    var IsBooked:Boolean? = null
    var IsWaitListed:Boolean? = null
    var CancelHours:Int? = null
    var LeadTime:Int? = null
    var MaxLeadTime:Int? = null
}

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

Kotlin CheckBookingStatusRequest DTOs

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

HTTP + XML

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

GET /scheduling/booking-status-check HTTP/1.1 
Host: clubready.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckBookingStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <AvailableCredits>0</AvailableCredits>
  <CanBook>false</CanBook>
  <CancelHours>0</CancelHours>
  <ConsumesCredit>false</ConsumesCredit>
  <IsBooked>false</IsBooked>
  <IsWaitListed>false</IsWaitListed>
  <LeadTime>0</LeadTime>
  <MaxLeadTime>0</MaxLeadTime>
  <Source>String</Source>
</CheckBookingStatusResponse>