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}

export class CustomerNote
{
    public NoteId: number;
    public Scope: string;
    public Text: string;
    public IsPriority: boolean;
    public CreatedByUserId?: string;
    public CreatedByName: string;
    public CreatedAt?: string;
    public DoneAt?: string;
    public IsCarry: boolean;
    public ShownAt?: string;

    public constructor(init?: Partial<CustomerNote>) { (Object as any).assign(this, init); }
}

export class CustomerNoteResponse
{
    public ResponseStatus: ResponseStatus;
    public Notes: CustomerNote[] = [];
    public Carry: CustomerNote[] = [];
    public CanPriority: boolean;
    public Note: CustomerNote;

    public constructor(init?: Partial<CustomerNoteResponse>) { (Object as any).assign(this, init); }
}

export class CustomerNoteDeleteRequest
{
    public Id: string;
    public NoteId: number;

    public constructor(init?: Partial<CustomerNoteDeleteRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}