Trendsic Platform Service

DispatchNoticeRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/notice/{Token}/json

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 DispatchNoticeResponse:
    ref_code: Optional[str] = None
    recipient_name: Optional[str] = None
    headline: Optional[str] = None
    body: Optional[str] = None
    affected_text: Optional[str] = None
    original_window: Optional[str] = None
    new_window: Optional[str] = None
    scope_label: Optional[str] = None
    reason: Optional[str] = None
    hold_status: Optional[str] = None
    resumes_utc: Optional[datetime.datetime] = None
    acked: bool = False
    invalid: bool = False
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchNoticeRequest:
    token: Optional[str] = None

Python DispatchNoticeRequest 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.

GET /v1/dispatch/notice/{Token}/json HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<DispatchNoticeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Acked>false</Acked>
  <AffectedText>String</AffectedText>
  <Body>String</Body>
  <Headline>String</Headline>
  <HoldStatus>String</HoldStatus>
  <Invalid>false</Invalid>
  <NewWindow>String</NewWindow>
  <OriginalWindow>String</OriginalWindow>
  <Reason>String</Reason>
  <RecipientName>String</RecipientName>
  <RefCode>String</RefCode>
  <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>
  <ResumesUtc>0001-01-01T00:00:00</ResumesUtc>
  <ScopeLabel>String</ScopeLabel>
</DispatchNoticeResponse>