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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class Notice
    {
        public virtual int NoticeId { get; set; }
        public virtual DateTime BeginDate { get; set; }
        public virtual DateTime ExpireDate { get; set; }
        public virtual string NoticeTitle { get; set; }
        public virtual string NoticeDescription { get; set; }
        public virtual string NoticeFullText { get; set; }
        public virtual int OrderIndex { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual bool IsUrgent { get; set; }
    }

    public partial class NoticeRequest
    {
        public virtual DateTime DateAsOf { get; set; }
        public virtual List<Notice> Notice { get; set; } = [];
    }

    public partial class NoticeResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<Notice> Notice { get; set; } = [];
    }

}

C# 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
		}
	]
}