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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiDtoBase:
    api_key: Optional[str] = None
    store_id: Optional[int] = None
    chain_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckClassBookingStatusRequestDto(ApiDtoBase):
    class_schedule_id: int = 0
    user_id: int = 0


class RestrictedResourceType(str, Enum):
    STORE = 'Store'
    CHAIN = 'Chain'
    USER = 'User'
    UNDEFINED = 'Undefined'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckBookingStatusRequest(CheckClassBookingStatusRequestDto, IRestrictedApiRequest):
    # @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    api_key: Optional[str] = None
    """
    Api Key - grants access to resources
    """


    # @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
    chain_id: Optional[int] = None
    """
    Chain ID
    """


    # @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    Store ID
    """


    # @ApiMember(DataType="integer", Description="ClubReady Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")
    class_schedule_id: int = 0
    """
    ClubReady Class Schedule ID
    """


    # @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
    user_id: int = 0
    """
    ClubReady User ID
    """


    restricted_id: Optional[int] = None
    restricted_resource_type: Optional[RestrictedResourceType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiResponseBase:
    success: bool = False
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckBookingStatusResponseDto(ApiResponseBase):
    can_book: bool = False
    consumes_credit: bool = False
    source: Optional[str] = None
    available_credits: int = 0
    is_booked: bool = False
    is_wait_listed: bool = False
    cancel_hours: int = 0
    lead_time: int = 0
    max_lead_time: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckBookingStatusResponse(CheckBookingStatusResponseDto):
    success: bool = False
    message: Optional[str] = None
    can_book: bool = False
    consumes_credit: bool = False
    source: Optional[str] = None
    available_credits: int = 0
    is_booked: bool = False
    is_wait_listed: bool = False
    cancel_hours: int = 0
    lead_time: int = 0
    max_lead_time: Optional[int] = None

Python CheckBookingStatusRequest 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.

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

{
	Success: False,
	Message: String,
	CanBook: False,
	ConsumesCredit: False,
	Source: String,
	AvailableCredits: 0,
	IsBooked: False,
	IsWaitListed: False,
	CancelHours: 0,
	LeadTime: 0,
	MaxLeadTime: 0
}