| GET | /users/find | Find a member. |
|---|
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 SearchUsersRequestDto(ApiDtoBase):
barcode: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
email: Optional[str] = None
phone: Optional[str] = None
user_type: Optional[int] = None
page: 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 SearchUsersRequest(SearchUsersRequestDto, 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="string", Description="Filter by First Name", Name="FirstName", ParameterType="query")
first_name: Optional[str] = None
"""
Filter by First Name
"""
# @ApiMember(DataType="string", Description="Filter by Last Name", Name="LastName", ParameterType="query")
last_name: Optional[str] = None
"""
Filter by Last Name
"""
# @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="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
chain_id: Optional[int] = None
"""
StoreId OR ChainId is required
"""
# @ApiMember(DataType="string", Description="Filter by barcode", Name="Barcode", ParameterType="query")
barcode: Optional[str] = None
"""
Filter by barcode
"""
# @ApiMember(DataType="string", Description="Filter by Email Address", Name="Email", ParameterType="query")
email: Optional[str] = None
"""
Filter by Email Address
"""
# @ApiMember(DataType="string", Description="Filter by Phone Number", Name="Phone", ParameterType="query")
phone: Optional[str] = None
"""
Filter by Phone Number
"""
# @ApiMember(DataType="integer", Description="Filter by ClubReady User Type", Name="UserType", ParameterType="query")
user_type: Optional[int] = None
"""
Filter by ClubReady User Type
"""
# @ApiMember(DataType="integer", Description="Page of users to retrieve. Pulls back 100 users per page.", Name="Page", ParameterType="query")
page: Optional[int] = None
"""
Page of users to retrieve. Pulls back 100 users per page.
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
Python SearchUsersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/find HTTP/1.1 Host: clubready.com Accept: text/csv