Trendsic Platform Service

<back to all web services

FormSubmissionRequestPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info/preview
"use strict";
export class FormRequestItem {
    /** @param {{K?:string,L?:string,Tag?:string,Tone?:string,Pre?:boolean,IsSignature?:boolean,IsSensitive?:boolean,Pi?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    K;
    /** @type {string} */
    L;
    /** @type {string} */
    Tag;
    /** @type {string} */
    Tone;
    /** @type {boolean} */
    Pre;
    /** @type {boolean} */
    IsSignature;
    /** @type {boolean} */
    IsSensitive;
    /** @type {number} */
    Pi;
}
export class FormRequestPlan {
    /** @param {{Items?:FormRequestItem[],Keys?:string[],Resign?:string[],ResignKeys?:string[],Channels?:string,StageLabel?:string,Consequence?:string,Applicant?:string,Stage?:string,CanSend?:boolean,Refusal?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormRequestItem[]} */
    Items = [];
    /** @type {string[]} */
    Keys = [];
    /** @type {string[]} */
    Resign = [];
    /** @type {string[]} */
    ResignKeys = [];
    /** @type {string} */
    Channels;
    /** @type {string} */
    StageLabel;
    /** @type {string} */
    Consequence;
    /** @type {string} */
    Applicant;
    /** @type {string} */
    Stage;
    /** @type {boolean} */
    CanSend;
    /** @type {string} */
    Refusal;
}
export class FormSubmissionRequestPreviewResponse {
    /** @param {{Plan?:FormRequestPlan,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormRequestPlan} */
    Plan;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormSubmissionRequestPreviewRequest {
    /** @param {{SubmissionUID?:string,Keys?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SubmissionUID;
    /** @type {string[]} */
    Keys = [];
}

JavaScript FormSubmissionRequestPreviewRequest 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/submissions/{SubmissionUID}/request-info/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SubmissionUID":"00000000000000000000000000000000","Keys":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Plan":{"Items":[{"K":"String","L":"String","Tag":"String","Tone":"String","Pre":false,"IsSignature":false,"IsSensitive":false,"Pi":0}],"Keys":["String"],"Resign":["String"],"ResignKeys":["String"],"Channels":"String","StageLabel":"String","Consequence":"String","Applicant":"String","Stage":"String","CanSend":false,"Refusal":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}