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
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUserNotesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <PostedBy xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</PostedBy>
  <UserNotes xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <SubmittedNote>
      <Subject>String</Subject>
      <Text>String</Text>
      <UserId>0</UserId>
    </SubmittedNote>
  </UserNotes>
</CreateUserNotesRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateUserNotesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <NoteIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:long>0</d2p1:long>
  </NoteIds>
</CreateUserNotesResponse>