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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormInboxCount
    {
        public virtual string V { get; set; }
        public virtual string L { get; set; }
        public virtual int N { get; set; }
    }

    public partial class FormNoticePreviewRequest
    {
        public virtual Guid FormUID { get; set; }
        public virtual string Id { get; set; }
        public virtual string Lang { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Subject { get; set; }
        public virtual string Body { get; set; }
        public virtual string Text { get; set; }
        public virtual string Closing { get; set; }
        public virtual Guid? SubmissionUID { get; set; }
    }

    public partial class FormNoticePreviewResponse
    {
        public virtual string Subject { get; set; }
        public virtual string Body { get; set; }
        public virtual string Meta { get; set; }
        public virtual string SubmissionUID { get; set; }
        public virtual bool Sample { get; set; }
        public virtual string SampleNote { get; set; }
        public virtual int TextLength { get; set; }
        public virtual int Segments { get; set; }
        public virtual bool Wide { get; set; }
        public virtual List<string> Problems { get; set; } = [];
        public virtual List<FormInboxCount> Samples { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# FormNoticePreviewRequest 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

HTTP + JSON

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

{"FormUID":"00000000000000000000000000000000","Id":"String","Lang":"String","Channel":"String","Subject":"String","Body":"String","Text":"String","Closing":"String","SubmissionUID":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Subject":"String","Body":"String","Meta":"String","SubmissionUID":"String","Sample":false,"SampleNote":"String","TextLength":0,"Segments":0,"Wide":false,"Problems":["String"],"Samples":[{"V":"String","L":"String","N":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}