| GET | /users/{UserId}/visit-history | Get user visit history |
|---|
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 UserVisitHistoryRequestDto(ApiDtoBase):
user_id: int = 0
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'
# @Api(Description="Gets user check-in history based on a date range. Max 31 days.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserVisitHistoryRequest(UserVisitHistoryRequestDto, IRestrictedApiRequest):
"""
Gets user check-in history based on a date range. Max 31 days.
"""
# @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="", IsRequired=true, Name="UserId", ParameterType="query")
user_id: int = 0
"""
"""
# @ApiMember(DataType="string", 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="date", Description="(Format:YYYY-MM-DD)", IsRequired=true, Name="FromDate", ParameterType="query")
from_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
(Format:YYYY-MM-DD)
"""
# @ApiMember(DataType="date", Description="Max 31 Days (Format:YYYY-MM-DD)", IsRequired=true, Name="ToDate", ParameterType="query")
to_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Max 31 Days (Format:YYYY-MM-DD)
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
Python UserVisitHistoryRequest 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/{UserId}/visit-history HTTP/1.1
Host: clubready.com
Accept: text/csv