| GET | /club/visit-history | Return list of club visits, by club or entire chain. |
|---|
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 ClubVisitHistoryRequestDto(ApiDtoBase):
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
class RestrictedResourceType(str, Enum):
STORE = 'Store'
CHAIN = 'Chain'
USER = 'User'
UNDEFINED = 'Undefined'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClubVisitHistoryRequest(ClubVisitHistoryRequestDto, 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="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
store_id: Optional[int] = None
"""
Either StoreId or ChainId is required
"""
# @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
chain_id: Optional[int] = None
"""
Either StoreId or ChainId is required
"""
# @ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
UTC Format
"""
# @ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Max 24 Hours (UTC Format)
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiResponseBase:
success: bool = False
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClubVisitHistoryItem:
checkin_log_id: int = 0
user_id: int = 0
first_name: Optional[str] = None
last_name: Optional[str] = None
checkin_store_id: int = 0
checkin_location_name: Optional[str] = None
home_store_id: int = 0
home_store_location_name: Optional[str] = None
utc_time: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClubVisitHistoryResponseDto(ApiResponseBase):
total_visits: int = 0
visits: Optional[List[ClubVisitHistoryItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClubVisitHistoryResponse(ClubVisitHistoryResponseDto):
success: bool = False
message: Optional[str] = None
total_visits: int = 0
visits: Optional[List[ClubVisitHistoryItem]] = None
Python ClubVisitHistoryRequest 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 /club/visit-history HTTP/1.1 Host: www.clubready.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Success":false,"Message":"String","TotalVisits":0,"Visits":[{"CheckinLogId":0,"UserId":0,"FirstName":"String","LastName":"String","CheckinStoreId":0,"CheckinLocationName":"String","HomeStoreId":0,"HomeStoreLocationName":"String","UtcTime":"0001-01-01T00:00:00.0000000"}]}