| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/NoticeAdmin/{NoticeId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/NoticeAdmin/ |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Notice:
notice_id: int = 0
begin_date: datetime.datetime = datetime.datetime(1, 1, 1)
expire_date: datetime.datetime = datetime.datetime(1, 1, 1)
notice_title: Optional[str] = None
notice_description: Optional[str] = None
notice_full_text: Optional[str] = None
order_index: int = 0
is_active: bool = False
is_urgent: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NoticeAdminResponse:
response_status: Optional[ResponseStatus] = None
notice: List[Notice] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NoticeAdminRequest:
date_as_of: datetime.datetime = datetime.datetime(1, 1, 1)
notice_i_d: int = 0
notice: List[Notice] = field(default_factory=list)
Python NoticeAdminRequest 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.
POST /v1/NoticeAdmin/{NoticeId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
DateAsOf: 0001-01-01,
NoticeID: 0,
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
}
]
}