| POST | /users/{UserId}/notes/create | Add note to a user account. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class CreateUserNoteRequest extends CreateUserNoteRequestDto 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 String ApiKey = null;
/**
* ClubReady Club ID (StoreID internally)
*/
@ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
public Integer StoreId = null;
/**
* Create note for this ClubReady User ID
*/
@ApiMember(DataType="integer", Description="Create note for this ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")
public Integer UserId = null;
/**
* Subject of the note (Up to 255 characters)
*/
@ApiMember(DataType="string", Description="Subject of the note (Up to 255 characters)", IsRequired=true, Name="Subject", ParameterType="query")
public String Subject = null;
/**
* Text body of the note (Up to 2000 characters)
*/
@ApiMember(DataType="string", Description="Text body of the note (Up to 2000 characters)", IsRequired=true, Name="Text", ParameterType="query")
public String Text = null;
/**
* Note is being posted by this ClubReady User ID.
*/
@ApiMember(DataType="integer", Description="Note is being posted by this ClubReady User ID.", Name="PostedBy", ParameterType="query")
public Integer PostedBy = null;
public Integer RestrictedId = null;
public RestrictedResourceType RestrictedResourceType = null;
public String getApiKey() { return ApiKey; }
public CreateUserNoteRequest setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public CreateUserNoteRequest setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getUserId() { return UserId; }
public CreateUserNoteRequest setUserId(Integer value) { this.UserId = value; return this; }
public String getSubject() { return Subject; }
public CreateUserNoteRequest setSubject(String value) { this.Subject = value; return this; }
public String getText() { return Text; }
public CreateUserNoteRequest setText(String value) { this.Text = value; return this; }
public Integer getPostedBy() { return PostedBy; }
public CreateUserNoteRequest setPostedBy(Integer value) { this.PostedBy = value; return this; }
public Integer getRestrictedId() { return RestrictedId; }
public CreateUserNoteRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
public CreateUserNoteRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
}
public static class CreateUserNoteRequestDto extends ApiDtoBase
{
public Integer UserId = null;
public String Subject = null;
public String Text = null;
public Integer PostedBy = null;
public Integer getUserId() { return UserId; }
public CreateUserNoteRequestDto setUserId(Integer value) { this.UserId = value; return this; }
public String getSubject() { return Subject; }
public CreateUserNoteRequestDto setSubject(String value) { this.Subject = value; return this; }
public String getText() { return Text; }
public CreateUserNoteRequestDto setText(String value) { this.Text = value; return this; }
public Integer getPostedBy() { return PostedBy; }
public CreateUserNoteRequestDto setPostedBy(Integer value) { this.PostedBy = value; return this; }
}
public static class ApiDtoBase
{
public String ApiKey = null;
public Integer StoreId = null;
public Integer ChainId = null;
public String getApiKey() { return ApiKey; }
public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getChainId() { return ChainId; }
public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
}
public static enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined;
}
public static class CreateUserNoteResponse extends CreateUserNoteResponseDto
{
public Boolean Success = null;
public String Message = null;
public Long NoteId = null;
public Boolean isSuccess() { return Success; }
public CreateUserNoteResponse setSuccess(Boolean value) { this.Success = value; return this; }
public String getMessage() { return Message; }
public CreateUserNoteResponse setMessage(String value) { this.Message = value; return this; }
public Long getNoteId() { return NoteId; }
public CreateUserNoteResponse setNoteId(Long value) { this.NoteId = value; return this; }
}
public static class CreateUserNoteResponseDto extends ApiResponseBase
{
public Long NoteId = null;
public Long getNoteId() { return NoteId; }
public CreateUserNoteResponseDto setNoteId(Long value) { this.NoteId = value; return this; }
}
public static class ApiResponseBase
{
public Boolean Success = null;
public String Message = null;
public Boolean isSuccess() { return Success; }
public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
public String getMessage() { return Message; }
public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
}
}
Java CreateUserNoteRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/{UserId}/notes/create HTTP/1.1
Host: www.clubready.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateUserNoteRequest 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>
<Subject xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Subject>
<Text xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Text>
<UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</CreateUserNoteRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CreateUserNoteResponse 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> <NoteId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</NoteId> </CreateUserNoteResponse>