ClubReady Api

UsersListRequest

The following routes are available for this service:
GET	/users	Get users list filtered by date

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 UsersListRequestDto(ApiDtoBase):
    segment: Optional[str] = None
    activity_date: Optional[str] = None
    activity_operator: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UsersListRequest(UsersListRequestDto, 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 OR ChainId is required", Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    StoreId OR ChainId is required
    """


    # @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    chain_id: Optional[int] = None
    """
    StoreId OR ChainId is required
    """


    # @ApiMember(DataType="Date", Description="Date to use for filter", IsRequired=true, Name="ActivityDate", ParameterType="query")
    activity_date: Optional[str] = None
    """
    Date to use for filter
    """


    # @ApiMember(DataType="String", Description="The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.", Name="ActivityOperator", ParameterType="query")
    activity_operator: Optional[str] = None
    """
    The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.
    """


    # @ApiMember(DataType="string", Description="Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue", Name="Segment", ParameterType="query")
    segment: Optional[str] = None
    """
    Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue
    """


    restricted_id: Optional[int] = None
    restricted_resource_type: Optional[RestrictedResourceType] = None
    # @ApiMember(DataType="string", Description="Version 2 adds email and mobile phone to output", Name="Version", ParameterType="query")
    version: Optional[int] = None
    """
    Version 2 adds email and mobile phone to output
    """

Python UsersListRequest DTOs

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

HTTP + CSV

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

GET /users HTTP/1.1 
Host: clubready.com 
Accept: text/csv