| POST | /users/checkusername | Check username availability |
|---|
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
class RestrictedResourceType(str, Enum):
STORE = 'Store'
CHAIN = 'Chain'
USER = 'User'
UNDEFINED = 'Undefined'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckUsernameRequest(ApiDtoBase, 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="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="string", Description="Username should be between 4 and 255 characters long", IsRequired=true, Name="Username", ParameterType="query")
username: Optional[str] = None
"""
Username should be between 4 and 255 characters long
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CheckUsernameResponse(IApiResponse):
valid: bool = False
status_code: int = 0
message: Optional[str] = None
Python CheckUsernameRequest 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.
POST /users/checkusername HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
StoreId: 0,
ChainId: 0,
Username: String,
RestrictedId: 0,
RestrictedResourceType: Chain
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Valid: False,
StatusCode: 0,
Message: String
}