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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<FFAgentConfigTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
  <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
</FFAgentConfigTemplateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FFAgentConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFAgentConfig>
    <AgentId>0</AgentId>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateModified>0001-01-01T00:00:00</DateModified>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <FFSections>
      <FFSectionExtended>
        <BorderColor>String</BorderColor>
        <BorderRadius>0</BorderRadius>
        <BorderWidth>0</BorderWidth>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <DateModified>0001-01-01T00:00:00</DateModified>
        <FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
        <HasBorder>false</HasBorder>
        <Header>String</Header>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <IsActive>false</IsActive>
        <Nickname>String</Nickname>
        <SectionTypeId>0</SectionTypeId>
        <ShowHeader>false</ShowHeader>
        <height>0</height>
        <width>0</width>
        <x>0</x>
        <y>0</y>
        <FFFields>
          <FFFieldExtended>
            <FFSectionId>00000000-0000-0000-0000-000000000000</FFSectionId>
            <FieldTypeId>0</FieldTypeId>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <Text>String</Text>
            <height>0</height>
            <width>0</width>
            <x>0</x>
            <y>0</y>
            <IsYesNo>false</IsYesNo>
            <Name>String</Name>
          </FFFieldExtended>
        </FFFields>
        <SectionTypeDesc>String</SectionTypeDesc>
      </FFSectionExtended>
    </FFSections>
  </FFAgentConfig>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FFAgentConfigResponse>