Trendsic Platform Service

<back to all web services

FormNoticePreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/notices/preview
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 FormInboxCount:
    v: Optional[str] = None
    l: Optional[str] = None
    n: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormNoticePreviewResponse:
    subject: Optional[str] = None
    body: Optional[str] = None
    meta: Optional[str] = None
    submission_u_i_d: Optional[str] = None
    sample: bool = False
    sample_note: Optional[str] = None
    text_length: int = 0
    segments: int = 0
    wide: bool = False
    problems: List[str] = field(default_factory=list)
    samples: List[FormInboxCount] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormNoticePreviewRequest:
    form_u_i_d: Optional[str] = None
    id: Optional[str] = None
    lang: Optional[str] = None
    channel: Optional[str] = None
    subject: Optional[str] = None
    body: Optional[str] = None
    text: Optional[str] = None
    closing: Optional[str] = None
    submission_u_i_d: Optional[str] = None

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

POST /v1/forms/{FormUID}/notices/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormNoticePreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Body>String</Body>
  <Channel>String</Channel>
  <Closing>String</Closing>
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <Id>String</Id>
  <Lang>String</Lang>
  <Subject>String</Subject>
  <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
  <Text>String</Text>
</FormNoticePreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormNoticePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Body>String</Body>
  <Meta>String</Meta>
  <Problems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Problems>
  <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>
  <Sample>false</Sample>
  <SampleNote>String</SampleNote>
  <Samples>
    <FormInboxCount>
      <L>String</L>
      <N>0</N>
      <V>String</V>
    </FormInboxCount>
  </Samples>
  <Segments>0</Segments>
  <Subject>String</Subject>
  <SubmissionUID>String</SubmissionUID>
  <TextLength>0</TextLength>
  <Wide>false</Wide>
</FormNoticePreviewResponse>