| Requires any of the roles: | Worker, Agent, Administrator |
| GET,POST,OPTIONS | /v1/Notice/{NoticeId} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/Notice | ||
| GET,OPTIONS | /v1/Notice/History/{DateAsOf} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DateAsOf | path | DateTime | No | |
| Notice | body | List<Notice> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoticeId | form | int | No | |
| BeginDate | form | DateTime | No | |
| ExpireDate | form | DateTime | No | |
| NoticeTitle | form | string | No | |
| NoticeDescription | form | string | No | |
| NoticeFullText | form | string | No | |
| OrderIndex | form | int | No | |
| IsActive | form | bool | No | |
| IsUrgent | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Notice | form | List<Notice> | 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.
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
}
]
}