| GET | /club/{StoreId}/Users/all | Get all Users for club |
|---|
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 GetAllUsersRequestDto(ApiDtoBase):
include_deleted: bool = False
class RestrictedResourceType(str, Enum):
STORE = 'Store'
CHAIN = 'Chain'
USER = 'User'
UNDEFINED = 'Undefined'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAllUsersRequest(GetAllUsersRequestDto, 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", IsRequired=true, Name="StoreId", ParameterType="query")
store_id: Optional[int] = None
"""
Store ID
"""
# @ApiMember(DataType="bool", Description="Include deleted users in result? (defaults to false)", Name="IncludeDeleted", ParameterType="query")
include_deleted: bool = False
"""
Include deleted users in result? (defaults to false)
"""
# @ApiMember(DataType="int", Description="Max number of records to include in the response.", Name="PageSize", ParameterType="query")
page_size: Optional[int] = None
"""
Max number of records to include in the response.
"""
# @ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")
page_number: Optional[int] = None
"""
Page number to retrieve.
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
Python GetAllUsersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /club/{StoreId}/Users/all HTTP/1.1
Host: clubready.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
UserId: 0,
Prospect: False,
Member: False,
DateAdded: 0001-01-01,
Email: String,
FirstName: String,
LastName: String,
StoreId: 0,
Username: String,
Address: String,
City: String,
State: String,
Zip: String,
Barcode: String,
Phone: String,
CellPhone: String,
ExternalUserId: String,
ProspectTypeName: String,
DateOfBirth: String,
MemberSinceDate: String,
MembershipExpiresDate: String,
MembershipEndedDate: String,
EmailOptOut: False,
SmsOptOut: False,
SmsOptIn: False,
ReferralTypeId: 0,
ReferralTypeName: String
}
]