GET | /users/{UserId} | Get user account summary |
---|
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 UserAccountInfoRequestDto(ApiDtoBase):
user_id: int = 0
full_detail: 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 UserAccountInfoRequest(UserAccountInfoRequestDto, 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="(debug id) Jen A = 28975", IsRequired=true, Name="UserId", ParameterType="query")
user_id: int = 0
"""
(debug id) Jen A = 28975
"""
# @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
store_id: Optional[int] = None
"""
StoreId OR ChainId is required
"""
# @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
chain_id: Optional[int] = None
"""
StoreId OR ChainId is required
"""
# @ApiMember(DataType="Boolean", Description="Whether you want full detail to be returned or a basic User object. (Format: true|false(default))", Name="FullDetail", ParameterType="query")
full_detail: bool = False
"""
Whether you want full detail to be returned or a basic User object. (Format: true|false(default))
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
Python UserAccountInfoRequest 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/{UserId} HTTP/1.1 Host: clubready.com Accept: text/jsv