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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FFAgentConfigTemplateRequest
{
    open var FFAgentConfigId:UUID? = null
    open var TemplateId:UUID? = null
}

open class FFAgentConfigResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var FFAgentConfig:FFAgentConfigExtended? = null
}

open class FFAgentConfigExtended : FFAgentConfig()
{
    open var FFSections:ArrayList<FFSectionExtended> = ArrayList<FFSectionExtended>()
}

open class FFAgentConfig
{
    open var Id:UUID? = null
    open var AgentId:Int? = null
    open var DateCreated:Date? = null
    open var DateModified:Date? = null
}

open class FFSectionExtended : FFSection()
{
    open var SectionTypeDesc:String? = null
    open var FFFields:ArrayList<FFFieldExtended> = ArrayList<FFFieldExtended>()
}

open class FFSection
{
    open var Id:UUID? = null
    open var FFAgentConfigId:UUID? = null
    open var SectionTypeId:Int? = null
    open var Nickname:String? = null
    open var ShowHeader:Boolean? = null
    open var Header:String? = null
    open var height:Int? = null
    open var width:Int? = null
    open var x:Int? = null
    open var y:Int? = null
    open var IsActive:Boolean? = null
    open var HasBorder:Boolean? = null
    open var BorderColor:String? = null
    open var BorderWidth:Int? = null
    open var BorderRadius:Int? = null
    open var DateCreated:Date? = null
    open var DateModified:Date? = null
}

open class FFFieldExtended : FFField()
{
    open var Name:String? = null
    open var IsYesNo:Boolean? = null
}

open class FFField
{
    open var Id:UUID? = null
    open var FFSectionId:UUID? = null
    open var FieldTypeId:Int? = null
    open var x:Int? = null
    open var y:Int? = null
    open var height:Int? = null
    open var width:Int? = null
    open var Text:String? = null
}

Kotlin 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>