Trendsic Platform Service

<back to all web services

CustomerNoteDeleteRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/customercheckins/{Id}/notes/{NoteId}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CustomerNoteDeleteRequest
    {
        public UUID Id = null;
        public Integer NoteId = null;
        
        public UUID getId() { return Id; }
        public CustomerNoteDeleteRequest setId(UUID value) { this.Id = value; return this; }
        public Integer getNoteId() { return NoteId; }
        public CustomerNoteDeleteRequest setNoteId(Integer value) { this.NoteId = value; return this; }
    }

    public static class CustomerNoteResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<CustomerNote> Notes = new ArrayList<CustomerNote>();
        public ArrayList<CustomerNote> Carry = new ArrayList<CustomerNote>();
        public Boolean CanPriority = null;
        public CustomerNote Note = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CustomerNoteResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<CustomerNote> getNotes() { return Notes; }
        public CustomerNoteResponse setNotes(ArrayList<CustomerNote> value) { this.Notes = value; return this; }
        public ArrayList<CustomerNote> getCarry() { return Carry; }
        public CustomerNoteResponse setCarry(ArrayList<CustomerNote> value) { this.Carry = value; return this; }
        public Boolean isCanPriority() { return CanPriority; }
        public CustomerNoteResponse setCanPriority(Boolean value) { this.CanPriority = value; return this; }
        public CustomerNote getNote() { return Note; }
        public CustomerNoteResponse setNote(CustomerNote value) { this.Note = value; return this; }
    }

    public static class CustomerNote
    {
        public Integer NoteId = null;
        public String Scope = null;
        public String Text = null;
        public Boolean IsPriority = null;
        public UUID CreatedByUserId = null;
        public String CreatedByName = null;
        public Date CreatedAt = null;
        public Date DoneAt = null;
        public Boolean IsCarry = null;
        public Date ShownAt = null;
        
        public Integer getNoteId() { return NoteId; }
        public CustomerNote setNoteId(Integer value) { this.NoteId = value; return this; }
        public String getScope() { return Scope; }
        public CustomerNote setScope(String value) { this.Scope = value; return this; }
        public String getText() { return Text; }
        public CustomerNote setText(String value) { this.Text = value; return this; }
        public Boolean getIsPriority() { return IsPriority; }
        public CustomerNote setIsPriority(Boolean value) { this.IsPriority = value; return this; }
        public UUID getCreatedByUserId() { return CreatedByUserId; }
        public CustomerNote setCreatedByUserId(UUID value) { this.CreatedByUserId = value; return this; }
        public String getCreatedByName() { return CreatedByName; }
        public CustomerNote setCreatedByName(String value) { this.CreatedByName = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public CustomerNote setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getDoneAt() { return DoneAt; }
        public CustomerNote setDoneAt(Date value) { this.DoneAt = value; return this; }
        public Boolean getIsCarry() { return IsCarry; }
        public CustomerNote setIsCarry(Boolean value) { this.IsCarry = value; return this; }
        public Date getShownAt() { return ShownAt; }
        public CustomerNote setShownAt(Date value) { this.ShownAt = value; return this; }
    }

}

Java CustomerNoteDeleteRequest DTOs

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.

DELETE /v1/customercheckins/{Id}/notes/{NoteId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Notes: 
	[
		{
			NoteId: 0,
			Scope: String,
			Text: String,
			IsPriority: False,
			CreatedByUserId: 00000000000000000000000000000000,
			CreatedByName: String,
			CreatedAt: 0001-01-01,
			DoneAt: 0001-01-01,
			IsCarry: False,
			ShownAt: 0001-01-01
		}
	],
	Carry: 
	[
		{
			NoteId: 0,
			Scope: String,
			Text: String,
			IsPriority: False,
			CreatedByUserId: 00000000000000000000000000000000,
			CreatedByName: String,
			CreatedAt: 0001-01-01,
			DoneAt: 0001-01-01,
			IsCarry: False,
			ShownAt: 0001-01-01
		}
	],
	CanPriority: False,
	Note: 
	{
		NoteId: 0,
		Scope: String,
		Text: String,
		IsPriority: False,
		CreatedByUserId: 00000000000000000000000000000000,
		CreatedByName: String,
		CreatedAt: 0001-01-01,
		DoneAt: 0001-01-01,
		IsCarry: False,
		ShownAt: 0001-01-01
	}
}