Trendsic Platform Service

CustomerNotesRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,POST,OPTIONS	/v1/customercheckins/{Id}/notes

"use strict";
export class CustomerNote {
    /** @param {{NoteId?:number,Scope?:string,Text?:string,IsPriority?:boolean,CreatedByUserId?:string,CreatedByName?:string,CreatedAt?:string,DoneAt?:string,IsCarry?:boolean,ShownAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NoteId;
    /** @type {string} */
    Scope;
    /** @type {string} */
    Text;
    /** @type {boolean} */
    IsPriority;
    /** @type {?string} */
    CreatedByUserId;
    /** @type {string} */
    CreatedByName;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    DoneAt;
    /** @type {boolean} */
    IsCarry;
    /** @type {?string} */
    ShownAt;
}
export class CustomerNoteResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Notes?:CustomerNote[],Carry?:CustomerNote[],CanPriority?:boolean,Note?:CustomerNote}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CustomerNote[]} */
    Notes = [];
    /** @type {CustomerNote[]} */
    Carry = [];
    /** @type {boolean} */
    CanPriority;
    /** @type {CustomerNote} */
    Note;
}
export class CustomerNotesRequest {
    /** @param {{Id?:string,Text?:string,Scope?:string,IsPriority?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Text;
    /** @type {string} */
    Scope;
    /** @type {boolean} */
    IsPriority;
}

JavaScript CustomerNotesRequest 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.

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

{
	Id: 00000000000000000000000000000000,
	Text: String,
	Scope: String,
	IsPriority: False
}

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