Trendsic Platform Service

NoticeReportRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/GetNoticeReport/{NoticeType}
PUT,OPTIONS	/v1/DisableNoticeReport/{NoticeType}/{AgentId}

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 NoticeReportResponse:
    response_status: Optional[ResponseStatus] = None
    notices: List[NoticeAgreement] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NoticeReportRequest:
    notice_type: Optional[str] = None
    agent_id: int = 0

Python NoticeReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<NoticeReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <NoticeType>String</NoticeType>
</NoticeReportRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NoticeReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Notices>
    <NoticeAgreement>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <FirstViewed>0001-01-01T00:00:00</FirstViewed>
      <Id>0</Id>
      <SignedDate>0001-01-01T00:00:00</SignedDate>
      <SnoozedDate>0001-01-01T00:00:00</SnoozedDate>
      <Status>String</Status>
    </NoticeAgreement>
  </Notices>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</NoticeReportResponse>