| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,OPTIONS | /v1/noticeAgreement/{AgentId} | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/noticeAgreement/{AgentId}/{Status} |
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 NoticeAgreement:
id: int = 0
agent_id: int = 0
agent_name: Optional[str] = None
status: Optional[str] = None
signed_date: datetime.datetime = datetime.datetime(1, 1, 1)
first_viewed: datetime.datetime = datetime.datetime(1, 1, 1)
snoozed_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NoticeAgreementResponse:
response_status: Optional[ResponseStatus] = None
agent_agreement: Optional[NoticeAgreement] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NoticeAgreementRequest:
agent_id: int = 0
status: Optional[str] = None
Python NoticeAgreementRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/noticeAgreement/{AgentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"AgentId":0,"Status":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AgentAgreement":{"Id":0,"AgentId":0,"AgentName":"String","Status":"String","SignedDate":"0001-01-01T00:00:00.0000000","FirstViewed":"0001-01-01T00:00:00.0000000","SnoozedDate":"0001-01-01T00:00:00.0000000"}}