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
"use strict";
export class FormInboxCount {
    /** @param {{V?:string,L?:string,N?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    V;
    /** @type {string} */
    L;
    /** @type {number} */
    N;
}
export class FormNoticePreviewResponse {
    /** @param {{Subject?:string,Body?:string,Meta?:string,SubmissionUID?:string,Sample?:boolean,SampleNote?:string,TextLength?:number,Segments?:number,Wide?:boolean,Problems?:string[],Samples?:FormInboxCount[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Subject;
    /** @type {string} */
    Body;
    /** @type {string} */
    Meta;
    /** @type {string} */
    SubmissionUID;
    /** @type {boolean} */
    Sample;
    /** @type {string} */
    SampleNote;
    /** @type {number} */
    TextLength;
    /** @type {number} */
    Segments;
    /** @type {boolean} */
    Wide;
    /** @type {string[]} */
    Problems = [];
    /** @type {FormInboxCount[]} */
    Samples = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormNoticePreviewRequest {
    /** @param {{FormUID?:string,Id?:string,Lang?:string,Channel?:string,Subject?:string,Body?:string,Text?:string,Closing?:string,SubmissionUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
    /** @type {string} */
    Id;
    /** @type {string} */
    Lang;
    /** @type {string} */
    Channel;
    /** @type {string} */
    Subject;
    /** @type {string} */
    Body;
    /** @type {string} */
    Text;
    /** @type {string} */
    Closing;
    /** @type {?string} */
    SubmissionUID;
}

JavaScript FormNoticePreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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