Trendsic Platform Service

<back to all web services

FFAgentConfigRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/FFAgentConfig

export class FFAgentConfig
{
    public Id: string;
    public AgentId: number;
    public DateCreated: string;
    public DateModified: string;

    public constructor(init?: Partial<FFAgentConfig>) { (Object as any).assign(this, init); }
}

export class FFSection
{
    public Id: string;
    public FFAgentConfigId: string;
    public SectionTypeId: number;
    public Nickname: string;
    public ShowHeader: boolean;
    public Header: string;
    public height: number;
    public width: number;
    public x: number;
    public y: number;
    public IsActive: boolean;
    public HasBorder: boolean;
    public BorderColor: string;
    public BorderWidth: number;
    public BorderRadius: number;
    public DateCreated: string;
    public DateModified: string;

    public constructor(init?: Partial<FFSection>) { (Object as any).assign(this, init); }
}

export class FFField
{
    public Id: string;
    public FFSectionId: string;
    public FieldTypeId: number;
    public x: number;
    public y: number;
    public height: number;
    public width: number;
    public Text: string;

    public constructor(init?: Partial<FFField>) { (Object as any).assign(this, init); }
}

export class FFFieldExtended extends FFField
{
    public Name: string;
    public IsYesNo: boolean;

    public constructor(init?: Partial<FFFieldExtended>) { super(init); (Object as any).assign(this, init); }
}

export class FFSectionExtended extends FFSection
{
    public SectionTypeDesc: string;
    public FFFields: FFFieldExtended[] = [];

    public constructor(init?: Partial<FFSectionExtended>) { super(init); (Object as any).assign(this, init); }
}

export class FFAgentConfigExtended extends FFAgentConfig
{
    public FFSections: FFSectionExtended[] = [];

    public constructor(init?: Partial<FFAgentConfigExtended>) { super(init); (Object as any).assign(this, init); }
}

export class FFAgentConfigResponse
{
    public ResponseStatus: ResponseStatus;
    public FFAgentConfig: FFAgentConfigExtended;

    public constructor(init?: Partial<FFAgentConfigResponse>) { (Object as any).assign(this, init); }
}

export class FFAgentConfigRequest
{
    public FFAgentConfig: FFAgentConfigExtended;

    public constructor(init?: Partial<FFAgentConfigRequest>) { (Object as any).assign(this, init); }
}

TypeScript FFAgentConfigRequest 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/FFAgentConfig HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"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"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}