| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/GetNoticeReport/{NoticeType} | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/DisableNoticeReport/{NoticeType}/{AgentId} |
"use strict";
export class NoticeAgreement {
/** @param {{Id?:number,AgentId?:number,AgentName?:string,Status?:string,SignedDate?:string,FirstViewed?:string,SnoozedDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
AgentId;
/** @type {string} */
AgentName;
/** @type {string} */
Status;
/** @type {string} */
SignedDate;
/** @type {string} */
FirstViewed;
/** @type {string} */
SnoozedDate;
}
export class NoticeReportResponse {
/** @param {{ResponseStatus?:ResponseStatus,Notices?:NoticeAgreement[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {NoticeAgreement[]} */
Notices = [];
}
export class NoticeReportRequest {
/** @param {{NoticeType?:string,AgentId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
NoticeType;
/** @type {number} */
AgentId;
}
JavaScript NoticeReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}