Trendsic Platform Service

<back to all web services

FormSettingsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/settings
"use strict";
export class FormReadinessCheck {
    /** @param {{Level?:string,Text?:string,FixTab?:string,FixFieldKey?:string,FixLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Level;
    /** @type {string} */
    Text;
    /** @type {string} */
    FixTab;
    /** @type {string} */
    FixFieldKey;
    /** @type {string} */
    FixLabel;
}
export class FormSettingsResponse {
    /** @param {{SettingsJson?:string,SettingsRev?:number,Link?:string,LinkPaused?:string,OfferChecks?:FormReadinessCheck[],DraftsInProgress?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SettingsJson;
    /** @type {number} */
    SettingsRev;
    /** @type {string} */
    Link;
    /** @type {string} */
    LinkPaused;
    /** @type {FormReadinessCheck[]} */
    OfferChecks = [];
    /** @type {number} */
    DraftsInProgress;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormSettingsRequest {
    /** @param {{FormUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
}

JavaScript FormSettingsRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/forms/{FormUID}/settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

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

{"SettingsJson":"String","SettingsRev":0,"Link":"String","LinkPaused":"String","OfferChecks":[{"Level":"String","Text":"String","FixTab":"String","FixFieldKey":"String","FixLabel":"String"}],"DraftsInProgress":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}