Trendsic Platform Service

FFAgentConfigTemplateRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
POST,OPTIONS	/v1/FFAgentConfigTemplate

import Foundation
import ServiceStack

public class FFAgentConfigTemplateRequest : Codable
{
    public var ffAgentConfigId:String
    public var templateId:String

    required public init(){}
}

public class FFAgentConfigResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var ffAgentConfig:FFAgentConfigExtended

    required public init(){}
}

public class FFAgentConfigExtended : FFAgentConfig
{
    public var ffSections:[FFSectionExtended] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case ffSections
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        ffSections = try container.decodeIfPresent([FFSectionExtended].self, forKey: .ffSections) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if ffSections.count > 0 { try container.encode(ffSections, forKey: .ffSections) }
    }
}

public class FFAgentConfig : Codable
{
    public var id:String
    public var agentId:Int
    public var dateCreated:Date
    public var dateModified:Date

    required public init(){}
}

public class FFSectionExtended : FFSection
{
    public var sectionTypeDesc:String
    public var ffFields:[FFFieldExtended] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case sectionTypeDesc
        case ffFields
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        sectionTypeDesc = try container.decodeIfPresent(String.self, forKey: .sectionTypeDesc)
        ffFields = try container.decodeIfPresent([FFFieldExtended].self, forKey: .ffFields) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if sectionTypeDesc != nil { try container.encode(sectionTypeDesc, forKey: .sectionTypeDesc) }
        if ffFields.count > 0 { try container.encode(ffFields, forKey: .ffFields) }
    }
}

public class FFSection : Codable
{
    public var id:String
    public var ffAgentConfigId:String
    public var sectionTypeId:Int
    public var nickname:String
    public var showHeader:Bool
    public var header:String
    public var height:Int
    public var width:Int
    public var x:Int
    public var y:Int
    public var isActive:Bool
    public var hasBorder:Bool
    public var borderColor:String
    public var borderWidth:Int
    public var borderRadius:Int
    public var dateCreated:Date
    public var dateModified:Date

    required public init(){}
}

public class FFFieldExtended : FFField
{
    public var name:String
    public var isYesNo:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case name
        case isYesNo
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        isYesNo = try container.decodeIfPresent(Bool.self, forKey: .isYesNo)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if name != nil { try container.encode(name, forKey: .name) }
        if isYesNo != nil { try container.encode(isYesNo, forKey: .isYesNo) }
    }
}

public class FFField : Codable
{
    public var id:String
    public var ffSectionId:String
    public var fieldTypeId:Int
    public var x:Int
    public var y:Int
    public var height:Int
    public var width:Int
    public var text:String

    required public init(){}
}

Swift 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"}}