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

export class FormInboxCount
{
    public V: string;
    public L: string;
    public N: number;

    public constructor(init?: Partial<FormInboxCount>) { (Object as any).assign(this, init); }
}

export class FormNoticePreviewResponse
{
    public Subject: string;
    public Body: string;
    public Meta: string;
    public SubmissionUID: string;
    public Sample: boolean;
    public SampleNote: string;
    public TextLength: number;
    public Segments: number;
    public Wide: boolean;
    public Problems: string[] = [];
    public Samples: FormInboxCount[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormNoticePreviewResponse>) { (Object as any).assign(this, init); }
}

export class FormNoticePreviewRequest
{
    public FormUID: string;
    public Id: string;
    public Lang: string;
    public Channel: string;
    public Subject: string;
    public Body: string;
    public Text: string;
    public Closing: string;
    public SubmissionUID?: string;

    public constructor(init?: Partial<FormNoticePreviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>