ClubReady Api

CreateUserNotesRequest

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


export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class SubmittedNote
{
    public UserId: number;
    public Subject: string;
    public Text: string;

    public constructor(init?: Partial<SubmittedNote>) { (Object as any).assign(this, init); }
}

export class CreateUserNotesRequestDto extends ApiDtoBase
{
    public PostedBy?: number;
    public UserNotes: SubmittedNote[];

    public constructor(init?: Partial<CreateUserNotesRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class CreateUserNotesRequest extends CreateUserNotesRequestDto implements IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * ClubReady Club ID (StoreID internally)
    */
    // @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * Notes are being posted by this ClubReady User ID.
    */
    // @ApiMember(DataType="integer", Description="Notes are being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")
    public PostedBy?: number;

    /**
    * Create notes
    */
    // @ApiMember(Description="Create notes", IsRequired=true, Name="UserNotes")
    public UserNotes: SubmittedNote[];

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<CreateUserNotesRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ApiResponseBase
{
    public Success: boolean;
    public Message: string;

    public constructor(init?: Partial<ApiResponseBase>) { (Object as any).assign(this, init); }
}

export class CreateUserNotesResponseDto extends ApiResponseBase
{
    public NoteIds: number[];

    public constructor(init?: Partial<CreateUserNotesResponseDto>) { super(init); (Object as any).assign(this, init); }
}

export class CreateUserNotesResponse extends CreateUserNotesResponseDto
{
    public NoteIds: number[];

    public constructor(init?: Partial<CreateUserNotesResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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
}