ClubReady Api

CreateUserNoteRequest

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

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

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CreateUserNoteRequestDto
        : ApiDtoBase
    {
        public virtual int UserId { get; set; }
        public virtual string Subject { get; set; }
        public virtual string Text { get; set; }
        public virtual int? PostedBy { get; set; }
    }

    public partial class CreateUserNoteResponseDto
        : ApiResponseBase
    {
        public virtual long NoteId { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Members.Model
{
    public partial class CreateUserNoteRequest
        : CreateUserNoteRequestDto, 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 virtual string ApiKey { get; set; }

        ///<summary>
        ///ClubReady Club ID (StoreID internally)
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<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 virtual int UserId { get; set; }

        ///<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 virtual string Subject { get; set; }

        ///<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 virtual string Text { get; set; }

        ///<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 virtual int? PostedBy { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class CreateUserNoteResponse
        : CreateUserNoteResponseDto
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual long NoteId { get; set; }
    }

}

C# 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: www.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
}