ClubReady Api

<back to all web services

GetClassScheduleRequest

Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today.

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 GetClassScheduleRequestDto(ApiDtoBase):
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    filter_by_category_id: Optional[int] = None


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


# @Api(Description="Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range.  Omitting dates will retrieve classes for today.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetClassScheduleRequest(GetClassScheduleRequestDto, IRestrictedApiRequest):
    """
    Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range.  Omitting dates will retrieve classes for today.
    """

    # @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="StoreID", IsRequired=true, Name="StoreID", ParameterType="query")
    store_id: Optional[int] = None
    """
    StoreID
    """


    # @ApiMember(DataType="date", Description="From Date (if blank, defaults to today; format: YYYY-MM-DD)", Name="FromDate", ParameterType="query")
    from_date: Optional[datetime.datetime] = None
    """
    From Date (if blank, defaults to today; format: YYYY-MM-DD)
    """


    # @ApiMember(DataType="date", Description="To Date (max 7 days; format: YYYY-MM-DD)", IsRequired=true, Name="ToDate", ParameterType="query")
    to_date: Optional[datetime.datetime] = None
    """
    To Date (max 7 days; format: YYYY-MM-DD)
    """


    # @ApiMember(DataType="int", Description="Id of Category Names to filter results by", Name="FilterByCategoryId", ParameterType="query")
    filter_by_category_id: Optional[int] = None
    """
    Id of Category Names to filter results by
    """


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

Python GetClassScheduleRequest DTOs

GET /scheduling/class-schedule HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv