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}

export class NoticeAgreement
{
    public Id: number;
    public AgentId: number;
    public AgentName: string;
    public Status: string;
    public SignedDate: string;
    public FirstViewed: string;
    public SnoozedDate: string;

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

export class NoticeReportResponse
{
    public ResponseStatus: ResponseStatus;
    public Notices: NoticeAgreement[] = [];

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

export class NoticeReportRequest
{
    public NoticeType: string;
    public AgentId: number;

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

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