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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class NoticeRequest
    {
        public Date DateAsOf = null;
        public ArrayList<Notice> Notice = new ArrayList<Notice>();
        
        public Date getDateAsOf() { return DateAsOf; }
        public NoticeRequest setDateAsOf(Date value) { this.DateAsOf = value; return this; }
        public ArrayList<Notice> getNotice() { return Notice; }
        public NoticeRequest setNotice(ArrayList<Notice> value) { this.Notice = value; return this; }
    }

    public static class Notice
    {
        public Integer NoticeId = null;
        public Date BeginDate = null;
        public Date ExpireDate = null;
        public String NoticeTitle = null;
        public String NoticeDescription = null;
        public String NoticeFullText = null;
        public Integer OrderIndex = null;
        public Boolean IsActive = null;
        public Boolean IsUrgent = null;
        
        public Integer getNoticeId() { return NoticeId; }
        public Notice setNoticeId(Integer value) { this.NoticeId = value; return this; }
        public Date getBeginDate() { return BeginDate; }
        public Notice setBeginDate(Date value) { this.BeginDate = value; return this; }
        public Date getExpireDate() { return ExpireDate; }
        public Notice setExpireDate(Date value) { this.ExpireDate = value; return this; }
        public String getNoticeTitle() { return NoticeTitle; }
        public Notice setNoticeTitle(String value) { this.NoticeTitle = value; return this; }
        public String getNoticeDescription() { return NoticeDescription; }
        public Notice setNoticeDescription(String value) { this.NoticeDescription = value; return this; }
        public String getNoticeFullText() { return NoticeFullText; }
        public Notice setNoticeFullText(String value) { this.NoticeFullText = value; return this; }
        public Integer getOrderIndex() { return OrderIndex; }
        public Notice setOrderIndex(Integer value) { this.OrderIndex = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public Notice setIsActive(Boolean value) { this.IsActive = value; return this; }
        public Boolean getIsUrgent() { return IsUrgent; }
        public Notice setIsUrgent(Boolean value) { this.IsUrgent = value; return this; }
    }

    public static class NoticeResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<Notice> Notice = new ArrayList<Notice>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public NoticeResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<Notice> getNotice() { return Notice; }
        public NoticeResponse setNotice(ArrayList<Notice> value) { this.Notice = value; return this; }
    }

}

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