Trendsic Platform Service

<back to all web services

NoticeReportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/GetNoticeReport/{NoticeType}
PUT,OPTIONS/v1/DisableNoticeReport/{NoticeType}/{AgentId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class NoticeReportRequest
{
    open var NoticeType:String? = null
    open var AgentId:Int? = null
}

open class NoticeReportResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Notices:ArrayList<NoticeAgreement> = ArrayList<NoticeAgreement>()
}

open class NoticeAgreement
{
    open var Id:Int? = null
    open var AgentId:Int? = null
    open var AgentName:String? = null
    open var Status:String? = null
    open var SignedDate:Date? = null
    open var FirstViewed:Date? = null
    open var SnoozedDate:Date? = null
}

Kotlin NoticeReportRequest 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.

PUT /v1/GetNoticeReport/{NoticeType} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NoticeType: String,
	AgentId: 0
}
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
		}
	},
	Notices: 
	[
		{
			Id: 0,
			AgentId: 0,
			AgentName: String,
			Status: String,
			SignedDate: 0001-01-01,
			FirstViewed: 0001-01-01,
			SnoozedDate: 0001-01-01
		}
	]
}