| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/GetNoticeReport/{NoticeType} | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/DisableNoticeReport/{NoticeType}/{AgentId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoticeType | path | string | No | |
| AgentId | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Notices | form | List<NoticeAgreement> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| AgentId | form | int | No | |
| AgentName | form | string | No | |
| Status | form | string | No | |
| SignedDate | form | DateTime | No | |
| FirstViewed | form | DateTime | No | |
| SnoozedDate | form | DateTime | No |
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
}
]
}