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}
NoticeRequest Parameters:
NameParameterData TypeRequiredDescription
DateAsOfpathDateTimeNo
NoticebodyList<Notice>No
Notice Parameters:
NameParameterData TypeRequiredDescription
NoticeIdformintNo
BeginDateformDateTimeNo
ExpireDateformDateTimeNo
NoticeTitleformstringNo
NoticeDescriptionformstringNo
NoticeFullTextformstringNo
OrderIndexformintNo
IsActiveformboolNo
IsUrgentformboolNo
NoticeResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NoticeformList<Notice>No

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