ClubReady Api

CreateUserNotesRequest

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

**CreateUserNotesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	Yes	ClubReady Club ID (StoreID internally)
PostedBy	query	integer	No	Notes are being posted by this ClubReady User ID.
UserNotes	body	List<SubmittedNote>	Yes	Create notes
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**CreateUserNotesRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
PostedBy	form	int?	No
UserNotes	form	List<SubmittedNote>	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**SubmittedNote** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
Subject	form	string	No
Text	form	string	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**CreateUserNotesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
NoteIds	form	List<long>	No

**CreateUserNotesResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
NoteIds	form	List<long>	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

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: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	XForwardedFor: String,
	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
}