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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}