Trendsic Platform Service

<back to all web services

NoticeAdminRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/NoticeAdmin/{NoticeId}
GET,POST,PUT,DELETE,OPTIONS/v1/NoticeAdmin/
"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 NoticeAdminResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Notice?:Notice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Notice[]} */
    Notice = [];
}
export class NoticeAdminRequest {
    /** @param {{DateAsOf?:string,NoticeID?:number,Notice?:Notice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DateAsOf;
    /** @type {number} */
    NoticeID;
    /** @type {Notice[]} */
    Notice = [];
}

JavaScript NoticeAdminRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/NoticeAdmin/{NoticeId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DateAsOf":"0001-01-01T00:00:00.0000000","NoticeID":0,"Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}