| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,OPTIONS | /v1/FFAgentConfig |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;
namespace CRM.AgencyPlatform.API.Internal
{
public partial class FFAgentConfig
{
public virtual Guid Id { get; set; }
public virtual int AgentId { get; set; }
public virtual DateTime DateCreated { get; set; }
public virtual DateTime DateModified { get; set; }
}
public partial class FFAgentConfigExtended
: FFAgentConfig
{
public virtual List<FFSectionExtended> FFSections { get; set; } = [];
}
public partial class FFAgentConfigRequest
{
public virtual FFAgentConfigExtended FFAgentConfig { get; set; }
}
public partial class FFAgentConfigResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual FFAgentConfigExtended FFAgentConfig { get; set; }
}
public partial class FFField
{
public virtual Guid Id { get; set; }
public virtual Guid FFSectionId { get; set; }
public virtual int FieldTypeId { get; set; }
public virtual int x { get; set; }
public virtual int y { get; set; }
public virtual int height { get; set; }
public virtual int width { get; set; }
public virtual string Text { get; set; }
}
public partial class FFFieldExtended
: FFField
{
public virtual string Name { get; set; }
public virtual bool IsYesNo { get; set; }
}
public partial class FFSection
{
public virtual Guid Id { get; set; }
public virtual Guid FFAgentConfigId { get; set; }
public virtual int SectionTypeId { get; set; }
public virtual string Nickname { get; set; }
public virtual bool ShowHeader { get; set; }
public virtual string Header { get; set; }
public virtual int height { get; set; }
public virtual int width { get; set; }
public virtual int x { get; set; }
public virtual int y { get; set; }
public virtual bool IsActive { get; set; }
public virtual bool HasBorder { get; set; }
public virtual string BorderColor { get; set; }
public virtual int BorderWidth { get; set; }
public virtual int BorderRadius { get; set; }
public virtual DateTime DateCreated { get; set; }
public virtual DateTime DateModified { get; set; }
}
public partial class FFSectionExtended
: FFSection
{
public virtual string SectionTypeDesc { get; set; }
public virtual List<FFFieldExtended> FFFields { get; set; } = [];
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<FFAgentConfigRequest 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>
</FFAgentConfigRequest>
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>