ClubReady Api

<back to all web services

CreateUserNotesRequest

The following routes are available for this service:
POST/users/notes/createAdd multiple notes.
CreateUserNotesRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesClubReady Club ID (StoreID internally)
PostedByqueryintegerNoNotes are being posted by this ClubReady User ID.
UserNotesbodyList<SubmittedNote>YesCreate notes
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
CreateUserNotesRequestDto Parameters:
NameParameterData TypeRequiredDescription
PostedByformint?No
UserNotesformList<SubmittedNote>No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
SubmittedNote Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
SubjectformstringNo
TextformstringNo
RestrictedResourceType Enum:
Store
Chain
User
Undefined
CreateUserNotesResponse Parameters:
NameParameterData TypeRequiredDescription
NoteIdsformList<long>No
CreateUserNotesResponseDto Parameters:
NameParameterData TypeRequiredDescription
NoteIdsformList<long>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"NoteIds":[0],"Success":false,"Message":"String"}