| POST | /users/{UserId}/notes/create | Add note to a user account. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CreateUserNoteRequest : CreateUserNoteRequestDto(), IRestrictedApiRequest
{
/**
* Api Key - grants access to resources
*/
@ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
var ApiKey:String? = null
/**
* ClubReady Club ID (StoreID internally)
*/
@ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
var StoreId:Int? = null
/**
* Create note for this ClubReady User ID
*/
@ApiMember(DataType="integer", Description="Create note for this ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
var UserId:Int? = null
/**
* Subject of the note (Up to 255 characters)
*/
@ApiMember(DataType="string", Description="Subject of the note (Up to 255 characters)", IsRequired=true, Name="Subject", ParameterType="query")
var Subject:String? = null
/**
* Text body of the note (Up to 2000 characters)
*/
@ApiMember(DataType="string", Description="Text body of the note (Up to 2000 characters)", IsRequired=true, Name="Text", ParameterType="query")
var Text:String? = null
/**
* Note is being posted by this ClubReady User ID.
*/
@ApiMember(DataType="integer", Description="Note is being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")
var PostedBy:Int? = null
var RestrictedId:Int? = null
var RestrictedResourceType:RestrictedResourceType? = null
}
open class CreateUserNoteRequestDto : ApiDtoBase()
{
var UserId:Int? = null
var Subject:String? = null
var Text:String? = null
var PostedBy:Int? = null
}
open class ApiDtoBase
{
var ApiKey:String? = null
var StoreId:Int? = null
var ChainId:Int? = null
}
enum class RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
open class CreateUserNoteResponse : CreateUserNoteResponseDto()
{
var Success:Boolean? = null
var Message:String? = null
var NoteId:Long? = null
}
open class CreateUserNoteResponseDto : ApiResponseBase()
{
var NoteId:Long? = null
}
open class ApiResponseBase
{
var Success:Boolean? = null
var Message:String? = null
}
Kotlin 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}