ClubReady Api

<back to all web services

CreditDetailRequest

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


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditDetailRequest(ApiDtoBase, 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 User ID", IsRequired=true, Name="UserId", ParameterType="path")
    user_id: int = 0
    """
    ClubReady User ID
    """


    # @ApiMember(DataType="Boolean", Description="Determines if the list of the user's credits are broken out by store ID.", Name="FullDetail", ParameterType="query")
    full_detail: bool = False
    """
    Determines if the list of the user's credits are broken out by store 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 SessionCreditDetail:
    service_id: Optional[int] = None
    session_size_id: Optional[int] = None
    class_id: Optional[int] = None
    name: Optional[str] = None
    total: int = 0
    available: int = 0
    store_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditDetailResponseDto(ApiResponseBase):
    total_purchased: Optional[int] = None
    total_available: Optional[int] = None
    credits: Optional[List[SessionCreditDetail]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditDetailResponse(CreditDetailResponseDto):
    success: bool = False
    message: Optional[str] = None
    total_purchased: Optional[int] = None
    total_available: Optional[int] = None
    credits: Optional[List[SessionCreditDetail]] = None

Python CreditDetailRequest DTOs

GET /scheduling/{UserId}/credit-detail HTTP/1.1 
Host: clubready.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Message":"String","TotalPurchased":0,"TotalAvailable":0,"Credits":[{"ServiceId":0,"SessionSizeId":0,"ClassId":0,"Name":"String","Total":0,"Available":0,"StoreId":0}]}