| POST | /users/{UserId}/notes/create | Add note to a user account. |
|---|
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 CreateUserNoteRequestDto(ApiDtoBase):
user_id: int = 0
subject: Optional[str] = None
text: Optional[str] = None
posted_by: 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 CreateUserNoteRequest(CreateUserNoteRequestDto, 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="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
store_id: Optional[int] = None
"""
ClubReady Club ID (StoreID internally)
"""
# @ApiMember(DataType="integer", Description="Create note for this ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
user_id: int = 0
"""
Create note for this ClubReady User ID
"""
# @ApiMember(DataType="string", Description="Subject of the note (Up to 255 characters)", IsRequired=true, Name="Subject", ParameterType="query")
subject: Optional[str] = None
"""
Subject of the note (Up to 255 characters)
"""
# @ApiMember(DataType="string", Description="Text body of the note (Up to 2000 characters)", IsRequired=true, Name="Text", ParameterType="query")
text: Optional[str] = None
"""
Text body of the note (Up to 2000 characters)
"""
# @ApiMember(DataType="integer", Description="Note is being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")
posted_by: Optional[int] = None
"""
Note is being posted by this ClubReady User ID.
"""
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 CreateUserNoteResponseDto(ApiResponseBase):
note_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateUserNoteResponse(CreateUserNoteResponseDto):
success: bool = False
message: Optional[str] = None
note_id: int = 0
Python CreateUserNoteRequest 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.
POST /users/{UserId}/notes/create HTTP/1.1
Host: clubready.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ApiKey":"String","StoreId":0,"UserId":0,"Subject":"String","Text":"String","PostedBy":0,"RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Success":false,"Message":"String","NoteId":0}