Trendsic Platform Service

<back to all web services

FormFillWithdrawRequest

The following routes are available for this service:
POST/v1/formfill/status/{Token}/withdraw
"use strict";
export class FormFillStage {
    /** @param {{Id?:string,Label?:string,Tone?:string,Kind?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Label;
    /** @type {string} */
    Tone;
    /** @type {string} */
    Kind;
}
export class FormFillStageSeen {
    /** @param {{Id?:string,At?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    At;
}
export class FormFillReceiptLine {
    /** @param {{Channel?:string,To?:string,Outcome?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Channel;
    /** @type {string} */
    To;
    /** @type {string} */
    Outcome;
}
export class FormFillStatusResponse {
    /** @param {{Number?:string,FormName?:string,Noun?:string,TenantName?:string,Stage?:string,StageKind?:string,Stages?:FormFillStage[],Seen?:FormFillStageSeen[],SubmittedAt?:string,Receipt?:FormFillReceiptLine[],CanWithdraw?:boolean,Lang?:string,NounEs?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Number;
    /** @type {string} */
    FormName;
    /** @type {string} */
    Noun;
    /** @type {string} */
    TenantName;
    /** @type {string} */
    Stage;
    /** @type {string} */
    StageKind;
    /** @type {FormFillStage[]} */
    Stages = [];
    /** @type {FormFillStageSeen[]} */
    Seen = [];
    /** @type {?string} */
    SubmittedAt;
    /** @type {FormFillReceiptLine[]} */
    Receipt = [];
    /** @type {boolean} */
    CanWithdraw;
    /** @type {string} */
    Lang;
    /** @type {string} */
    NounEs;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormFillWithdrawRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript FormFillWithdrawRequest 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/formfill/status/{Token}/withdraw HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Token":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Number":"String","FormName":"String","Noun":"String","TenantName":"String","Stage":"String","StageKind":"String","Stages":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"Seen":[{"Id":"String","At":"0001-01-01T00:00:00.0000000"}],"SubmittedAt":"0001-01-01T00:00:00.0000000","Receipt":[{"Channel":"String","To":"String","Outcome":"String"}],"CanWithdraw":false,"Lang":"String","NounEs":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}