Trendsic Platform Service

<back to all web services

FFAgentConfigTemplateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/FFAgentConfigTemplate
"use strict";
export class FFAgentConfig {
    /** @param {{Id?:string,AgentId?:number,DateCreated?:string,DateModified?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateModified;
}
export class FFSection {
    /** @param {{Id?:string,FFAgentConfigId?:string,SectionTypeId?:number,Nickname?:string,ShowHeader?:boolean,Header?:string,height?:number,width?:number,x?:number,y?:number,IsActive?:boolean,HasBorder?:boolean,BorderColor?:string,BorderWidth?:number,BorderRadius?:number,DateCreated?:string,DateModified?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    FFAgentConfigId;
    /** @type {number} */
    SectionTypeId;
    /** @type {string} */
    Nickname;
    /** @type {boolean} */
    ShowHeader;
    /** @type {string} */
    Header;
    /** @type {number} */
    height;
    /** @type {number} */
    width;
    /** @type {number} */
    x;
    /** @type {number} */
    y;
    /** @type {boolean} */
    IsActive;
    /** @type {boolean} */
    HasBorder;
    /** @type {string} */
    BorderColor;
    /** @type {number} */
    BorderWidth;
    /** @type {number} */
    BorderRadius;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    DateModified;
}
export class FFField {
    /** @param {{Id?:string,FFSectionId?:string,FieldTypeId?:number,x?:number,y?:number,height?:number,width?:number,Text?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    FFSectionId;
    /** @type {number} */
    FieldTypeId;
    /** @type {number} */
    x;
    /** @type {number} */
    y;
    /** @type {number} */
    height;
    /** @type {number} */
    width;
    /** @type {string} */
    Text;
}
export class FFFieldExtended extends FFField {
    /** @param {{Name?:string,IsYesNo?:boolean,Id?:string,FFSectionId?:string,FieldTypeId?:number,x?:number,y?:number,height?:number,width?:number,Text?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {boolean} */
    IsYesNo;
}
export class FFSectionExtended extends FFSection {
    /** @param {{SectionTypeDesc?:string,FFFields?:FFFieldExtended[],Id?:string,FFAgentConfigId?:string,SectionTypeId?:number,Nickname?:string,ShowHeader?:boolean,Header?:string,height?:number,width?:number,x?:number,y?:number,IsActive?:boolean,HasBorder?:boolean,BorderColor?:string,BorderWidth?:number,BorderRadius?:number,DateCreated?:string,DateModified?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    SectionTypeDesc;
    /** @type {FFFieldExtended[]} */
    FFFields = [];
}
export class FFAgentConfigExtended extends FFAgentConfig {
    /** @param {{FFSections?:FFSectionExtended[],Id?:string,AgentId?:number,DateCreated?:string,DateModified?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {FFSectionExtended[]} */
    FFSections = [];
}
export class FFAgentConfigResponse {
    /** @param {{ResponseStatus?:ResponseStatus,FFAgentConfig?:FFAgentConfigExtended}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {FFAgentConfigExtended} */
    FFAgentConfig;
}
export class FFAgentConfigTemplateRequest {
    /** @param {{FFAgentConfigId?:string,TemplateId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FFAgentConfigId;
    /** @type {string} */
    TemplateId;
}

JavaScript FFAgentConfigTemplateRequest 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/FFAgentConfigTemplate HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FFAgentConfigId":"00000000000000000000000000000000","TemplateId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"FFAgentConfig":{"FFSections":[{"SectionTypeDesc":"String","FFFields":[{"Name":"String","IsYesNo":false,"Id":"00000000000000000000000000000000","FFSectionId":"00000000000000000000000000000000","FieldTypeId":0,"x":0,"y":0,"height":0,"width":0,"Text":"String"}],"Id":"00000000000000000000000000000000","FFAgentConfigId":"00000000000000000000000000000000","SectionTypeId":0,"Nickname":"String","ShowHeader":false,"Header":"String","height":0,"width":0,"x":0,"y":0,"IsActive":false,"HasBorder":false,"BorderColor":"String","BorderWidth":0,"BorderRadius":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000"}],"Id":"00000000000000000000000000000000","AgentId":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000"}}