| 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 .xml suffix or ?format=xml
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: www.clubready.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfGetAllUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
<GetAllUsersResponse>
<Address>String</Address>
<Barcode>String</Barcode>
<CellPhone>String</CellPhone>
<City>String</City>
<DateAdded>0001-01-01T00:00:00</DateAdded>
<DateOfBirth>String</DateOfBirth>
<Email>String</Email>
<EmailOptOut>false</EmailOptOut>
<ExternalUserId>String</ExternalUserId>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Member>false</Member>
<MemberSinceDate>String</MemberSinceDate>
<MembershipEndedDate>String</MembershipEndedDate>
<MembershipExpiresDate>String</MembershipExpiresDate>
<Phone>String</Phone>
<Prospect>false</Prospect>
<ProspectTypeName>String</ProspectTypeName>
<ReferralTypeId>0</ReferralTypeId>
<ReferralTypeName>String</ReferralTypeName>
<SmsOptIn>false</SmsOptIn>
<SmsOptOut>false</SmsOptOut>
<State>String</State>
<StoreId>0</StoreId>
<UserId>0</UserId>
<Username>String</Username>
<Zip>String</Zip>
</GetAllUsersResponse>
</ArrayOfGetAllUsersResponse>