POST | /users/notes/create | Add multiple notes. |
---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static 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 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;
/**
* 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 Integer PostedBy = null;
/**
* Create notes
*/
@ApiMember(Description="Create notes", IsRequired=true, Name="UserNotes")
public ArrayList<SubmittedNote> UserNotes = null;
public Integer RestrictedId = null;
public RestrictedResourceType RestrictedResourceType = null;
public String getApiKey() { return ApiKey; }
public CreateUserNotesRequest setApiKey(String value) { this.ApiKey = value; return this; }
public Integer getStoreId() { return StoreId; }
public CreateUserNotesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
public Integer getPostedBy() { return PostedBy; }
public CreateUserNotesRequest setPostedBy(Integer value) { this.PostedBy = value; return this; }
public ArrayList<SubmittedNote> getUserNotes() { return UserNotes; }
public CreateUserNotesRequest setUserNotes(ArrayList<SubmittedNote> value) { this.UserNotes = value; return this; }
public Integer getRestrictedId() { return RestrictedId; }
public CreateUserNotesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
public CreateUserNotesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
}
public static class CreateUserNotesRequestDto extends ApiDtoBase
{
public Integer PostedBy = null;
public ArrayList<SubmittedNote> UserNotes = null;
public Integer getPostedBy() { return PostedBy; }
public CreateUserNotesRequestDto setPostedBy(Integer value) { this.PostedBy = value; return this; }
public ArrayList<SubmittedNote> getUserNotes() { return UserNotes; }
public CreateUserNotesRequestDto setUserNotes(ArrayList<SubmittedNote> value) { this.UserNotes = 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 class SubmittedNote
{
public Integer UserId = null;
public String Subject = null;
public String Text = null;
public Integer getUserId() { return UserId; }
public SubmittedNote setUserId(Integer value) { this.UserId = value; return this; }
public String getSubject() { return Subject; }
public SubmittedNote setSubject(String value) { this.Subject = value; return this; }
public String getText() { return Text; }
public SubmittedNote setText(String value) { this.Text = value; return this; }
}
public static enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined;
}
public static class CreateUserNotesResponse extends CreateUserNotesResponseDto
{
public ArrayList<Long> NoteIds = null;
public ArrayList<Long> getNoteIds() { return NoteIds; }
public CreateUserNotesResponse setNoteIds(ArrayList<Long> value) { this.NoteIds = value; return this; }
}
public static class CreateUserNotesResponseDto extends ApiResponseBase
{
public ArrayList<Long> NoteIds = null;
public ArrayList<Long> getNoteIds() { return NoteIds; }
public CreateUserNotesResponseDto setNoteIds(ArrayList<Long> value) { this.NoteIds = 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 CreateUserNotesRequest 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/notes/create HTTP/1.1
Host: 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>