ClubReady Api

CreateUserNotesRequest

The following routes are available for this service:
POST	/users/notes/create	Add multiple notes.

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 CreateUserNotesRequestDto
        : ApiDtoBase
    {
        public CreateUserNotesRequestDto()
        {
            UserNotes = new List<SubmittedNote>{};
        }

        public virtual int? PostedBy { get; set; }
        public virtual List<SubmittedNote> UserNotes { get; set; }
    }

    public partial class CreateUserNotesResponseDto
        : ApiResponseBase
    {
        public CreateUserNotesResponseDto()
        {
            NoteIds = new List<long>{};
        }

        public virtual List<long> NoteIds { get; set; }
    }

    public partial class SubmittedNote
    {
        public virtual int UserId { get; set; }
        public virtual string Subject { get; set; }
        public virtual string Text { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.Members.Model
{
    public partial class CreateUserNotesRequest
        : CreateUserNotesRequestDto, IRestrictedApiRequest
    {
        public CreateUserNotesRequest()
        {
            UserNotes = new List<SubmittedNote>{};
        }

        ///<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>
        ///Notes are being posted by this ClubReady User ID.
        ///</summary>
        [ApiMember(DataType="integer", Description="Notes are being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")]
        public virtual int? PostedBy { get; set; }

        ///<summary>
        ///Create notes
        ///</summary>
        [ApiMember(Description="Create notes", IsRequired=true, Name="UserNotes")]
        public virtual List<SubmittedNote> UserNotes { get; set; }

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

    public partial class CreateUserNotesResponse
        : CreateUserNotesResponseDto
    {
        public CreateUserNotesResponse()
        {
            NoteIds = new List<long>{};
        }

        public virtual List<long> NoteIds { get; set; }
    }

}

C# CreateUserNotesRequest 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/notes/create HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	StoreId: 0,
	PostedBy: 0,
	UserNotes: 
	[
		{
			UserId: 0,
			Subject: String,
			Text: String
		}
	],
	RestrictedId: 0,
	RestrictedResourceType: Store,
	ChainId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NoteIds: 
	[
		0
	],
	Success: False,
	Message: String
}