Trendsic Platform Service

<back to all web services

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}

export class Notice
{
    public NoticeId: number;
    public BeginDate: string;
    public ExpireDate: string;
    public NoticeTitle: string;
    public NoticeDescription: string;
    public NoticeFullText: string;
    public OrderIndex: number;
    public IsActive: boolean;
    public IsUrgent: boolean;

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

export class NoticeResponse
{
    public ResponseStatus: ResponseStatus;
    public Notice: Notice[] = [];

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

export class NoticeRequest
{
    public DateAsOf: string;
    public Notice: Notice[] = [];

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

TypeScript NoticeRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DateAsOf":"0001-01-01T00:00:00.0000000","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/jsonl
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}]}