ClubReady Api

StaffListRequest

The following routes are available for this service:
GET	/staff	Get Staff for a location

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 StaffListRequestDto(ApiDtoBase):
    staff_type: 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 StaffListRequest(StaffListRequestDto, 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="StoreId is required", IsRequired=true, Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    StoreId is required
    """


    # @ApiMember(DataType="integer", Description="ClubReady AdminTypeId", Name="StaffType", ParameterType="query")
    staff_type: Optional[int] = None
    """
    ClubReady AdminTypeId
    """


    restricted_id: Optional[int] = None
    restricted_resource_type: Optional[RestrictedResourceType] = None
    # @ApiMember(DataType="bool", Description="Restricts results to staff that are available for scheduling", Name="AvailableForScheduling", ParameterType="query")
    available_for_scheduling: Optional[bool] = None
    """
    Restricts results to staff that are available for scheduling
    """

Python StaffListRequest 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 /staff HTTP/1.1 
Host: clubready.com 
Accept: text/jsv