ClubReady Api

CreateUserNoteRequest

The following routes are available for this service:
POST	/users/{UserId}/notes/create	Add note to a user account.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Members.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class ApiResponseBase
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class

        Public Partial Class CreateUserNoteRequestDto
            Inherits ApiDtoBase
            Public Overridable Property UserId As Integer
            Public Overridable Property Subject As String
            Public Overridable Property Text As String
            Public Overridable Property PostedBy As Nullable(Of Integer)
        End Class

        Public Partial Class CreateUserNoteResponseDto
            Inherits ApiResponseBase
            Public Overridable Property NoteId As Long
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Members.Model

        Public Partial Class CreateUserNoteRequest
            Inherits CreateUserNoteRequestDto
            Implements IRestrictedApiRequest
            '''<Summary>
            '''Api Key - grants access to resources
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Api Key - grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''ClubReady Club ID (StoreID internally)
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady Club ID (StoreID internally)", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''Create note for this ClubReady User ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Create note for this ClubReady User ID", IsRequired:=true, Name:="UserId", ParameterType:="query")>
            Public Overridable Property UserId As Integer

            '''<Summary>
            '''Subject of the note (Up to 255 characters)
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Subject of the note (Up to 255 characters)", IsRequired:=true, Name:="Subject", ParameterType:="query")>
            Public Overridable Property Subject As String

            '''<Summary>
            '''Text body of the note (Up to 2000 characters)
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Text body of the note (Up to 2000 characters)", IsRequired:=true, Name:="Text", ParameterType:="query")>
            Public Overridable Property Text As String

            '''<Summary>
            '''Note is being posted by this ClubReady User ID.
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Note is being posted by this ClubReady User ID.", Name:="PostedBy", ParameterType:="query")>
            Public Overridable Property PostedBy As Nullable(Of Integer)

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class

        Public Partial Class CreateUserNoteResponse
            Inherits CreateUserNoteResponseDto
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
            Public Overridable Property NoteId As Long
        End Class
    End Namespace
End Namespace

VB.NET CreateUserNoteRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	NoteId: 0
}