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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FFAgentConfig() = 
        member val Id:Guid = new Guid() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val DateModified:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type FFSection() = 
        member val Id:Guid = new Guid() with get,set
        member val FFAgentConfigId:Guid = new Guid() with get,set
        member val SectionTypeId:Int32 = new Int32() with get,set
        member val Nickname:String = null with get,set
        member val ShowHeader:Boolean = new Boolean() with get,set
        member val Header:String = null with get,set
        member val height:Int32 = new Int32() with get,set
        member val width:Int32 = new Int32() with get,set
        member val x:Int32 = new Int32() with get,set
        member val y:Int32 = new Int32() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val HasBorder:Boolean = new Boolean() with get,set
        member val BorderColor:String = null with get,set
        member val BorderWidth:Int32 = new Int32() with get,set
        member val BorderRadius:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val DateModified:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type FFField() = 
        member val Id:Guid = new Guid() with get,set
        member val FFSectionId:Guid = new Guid() with get,set
        member val FieldTypeId:Int32 = new Int32() with get,set
        member val x:Int32 = new Int32() with get,set
        member val y:Int32 = new Int32() with get,set
        member val height:Int32 = new Int32() with get,set
        member val width:Int32 = new Int32() with get,set
        member val Text:String = null with get,set

    [<AllowNullLiteral>]
    type FFFieldExtended() = 
        inherit FFField()
        member val Name:String = null with get,set
        member val IsYesNo:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FFSectionExtended() = 
        inherit FFSection()
        member val SectionTypeDesc:String = null with get,set
        member val FFFields:ResizeArray<FFFieldExtended> = new ResizeArray<FFFieldExtended>() with get,set

    [<AllowNullLiteral>]
    type FFAgentConfigExtended() = 
        inherit FFAgentConfig()
        member val FFSections:ResizeArray<FFSectionExtended> = new ResizeArray<FFSectionExtended>() with get,set

    [<AllowNullLiteral>]
    type FFAgentConfigResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val FFAgentConfig:FFAgentConfigExtended = null with get,set

    [<AllowNullLiteral>]
    type FFAgentConfigTemplateRequest() = 
        member val FFAgentConfigId:Guid = new Guid() with get,set
        member val TemplateId:Guid = new Guid() with get,set

F# 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>