| GET | /users/date-added | List of users added in a certain date range. |
|---|
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 UserListDateAddedRequestDto(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 UserListDateAddedRequest(UserListDateAddedRequestDto, 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", Name="StoreId", ParameterType="query")
store_id: Optional[int] = None
"""
Store ID
"""
# @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 ClubClient:
user_id: int = 0
username: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
store_id: Optional[int] = None
date_added: Optional[datetime.datetime] = None
referred_by: Optional[int] = None
added_by: Optional[int] = None
referral_type_id: Optional[int] = None
referral_type_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserListDateAddedResponseDto:
users: Optional[List[ClubClient]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserListDateAddedResponse(UserListDateAddedResponseDto):
users: Optional[List[ClubClient]] = None
Python UserListDateAddedRequest 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 /users/date-added HTTP/1.1 Host: clubready.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Users:
[
{
UserId: 0,
Username: String,
FirstName: String,
LastName: String,
StoreId: 0,
DateAdded: 0001-01-01,
ReferredBy: 0,
AddedBy: 0,
ReferralTypeId: 0,
ReferralTypeName: String
}
]
}