Trendsic Platform Service

NoticeRequest

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

The following routes are available for this service:
GET,POST,OPTIONS	/v1/Notice/{NoticeId}
GET,OPTIONS	/v1/Notice
GET,OPTIONS	/v1/Notice/History/{DateAsOf}

"use strict";
export class Notice {
    /** @param {{NoticeId?:number,BeginDate?:string,ExpireDate?:string,NoticeTitle?:string,NoticeDescription?:string,NoticeFullText?:string,OrderIndex?:number,IsActive?:boolean,IsUrgent?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NoticeId;
    /** @type {string} */
    BeginDate;
    /** @type {string} */
    ExpireDate;
    /** @type {string} */
    NoticeTitle;
    /** @type {string} */
    NoticeDescription;
    /** @type {string} */
    NoticeFullText;
    /** @type {number} */
    OrderIndex;
    /** @type {boolean} */
    IsActive;
    /** @type {boolean} */
    IsUrgent;
}
export class NoticeResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Notice?:Notice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Notice[]} */
    Notice = [];
}
export class NoticeRequest {
    /** @param {{DateAsOf?:string,Notice?:Notice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DateAsOf;
    /** @type {Notice[]} */
    Notice = [];
}

JavaScript NoticeRequest 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/Notice/{NoticeId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DateAsOf: 0001-01-01,
	Notice: 
	[
		{
			NoticeId: 0,
			BeginDate: 0001-01-01,
			ExpireDate: 0001-01-01,
			NoticeTitle: String,
			NoticeDescription: String,
			NoticeFullText: String,
			OrderIndex: 0,
			IsActive: False,
			IsUrgent: 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
		}
	},
	Notice: 
	[
		{
			NoticeId: 0,
			BeginDate: 0001-01-01,
			ExpireDate: 0001-01-01,
			NoticeTitle: String,
			NoticeDescription: String,
			NoticeFullText: String,
			OrderIndex: 0,
			IsActive: False,
			IsUrgent: False
		}
	]
}