Trendsic Platform Service

<back to all web services

FFAgentConfigRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/FFAgentConfig
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FFAgentConfigRequest
    {
        public FFAgentConfigExtended FFAgentConfig = null;
        
        public FFAgentConfigExtended getFfAgentConfig() { return FFAgentConfig; }
        public FFAgentConfigRequest setFfAgentConfig(FFAgentConfigExtended value) { this.FFAgentConfig = value; return this; }
    }

    public static class FFAgentConfigExtended extends FFAgentConfig
    {
        public ArrayList<FFSectionExtended> FFSections = new ArrayList<FFSectionExtended>();
        
        public ArrayList<FFSectionExtended> getFfSections() { return FFSections; }
        public FFAgentConfigExtended setFfSections(ArrayList<FFSectionExtended> value) { this.FFSections = value; return this; }
    }

    public static class FFAgentConfig
    {
        public UUID Id = null;
        public Integer AgentId = null;
        public Date DateCreated = null;
        public Date DateModified = null;
        
        public UUID getId() { return Id; }
        public FFAgentConfig setId(UUID value) { this.Id = value; return this; }
        public Integer getAgentId() { return AgentId; }
        public FFAgentConfig setAgentId(Integer value) { this.AgentId = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public FFAgentConfig setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateModified() { return DateModified; }
        public FFAgentConfig setDateModified(Date value) { this.DateModified = value; return this; }
    }

    public static class FFSectionExtended extends FFSection
    {
        public String SectionTypeDesc = null;
        public ArrayList<FFFieldExtended> FFFields = new ArrayList<FFFieldExtended>();
        
        public String getSectionTypeDesc() { return SectionTypeDesc; }
        public FFSectionExtended setSectionTypeDesc(String value) { this.SectionTypeDesc = value; return this; }
        public ArrayList<FFFieldExtended> getFfFields() { return FFFields; }
        public FFSectionExtended setFfFields(ArrayList<FFFieldExtended> value) { this.FFFields = value; return this; }
    }

    public static class FFSection
    {
        public UUID Id = null;
        public UUID FFAgentConfigId = null;
        public Integer SectionTypeId = null;
        public String Nickname = null;
        public Boolean ShowHeader = null;
        public String Header = null;
        public Integer height = null;
        public Integer width = null;
        public Integer x = null;
        public Integer y = null;
        public Boolean IsActive = null;
        public Boolean HasBorder = null;
        public String BorderColor = null;
        public Integer BorderWidth = null;
        public Integer BorderRadius = null;
        public Date DateCreated = null;
        public Date DateModified = null;
        
        public UUID getId() { return Id; }
        public FFSection setId(UUID value) { this.Id = value; return this; }
        public UUID getFfAgentConfigId() { return FFAgentConfigId; }
        public FFSection setFfAgentConfigId(UUID value) { this.FFAgentConfigId = value; return this; }
        public Integer getSectionTypeId() { return SectionTypeId; }
        public FFSection setSectionTypeId(Integer value) { this.SectionTypeId = value; return this; }
        public String getNickname() { return Nickname; }
        public FFSection setNickname(String value) { this.Nickname = value; return this; }
        public Boolean isShowHeader() { return ShowHeader; }
        public FFSection setShowHeader(Boolean value) { this.ShowHeader = value; return this; }
        public String getHeader() { return Header; }
        public FFSection setHeader(String value) { this.Header = value; return this; }
        public Integer getHeight() { return height; }
        public FFSection setHeight(Integer value) { this.height = value; return this; }
        public Integer getWidth() { return width; }
        public FFSection setWidth(Integer value) { this.width = value; return this; }
        public Integer getX() { return x; }
        public FFSection setX(Integer value) { this.x = value; return this; }
        public Integer getY() { return y; }
        public FFSection setY(Integer value) { this.y = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public FFSection setIsActive(Boolean value) { this.IsActive = value; return this; }
        public Boolean isHasBorder() { return HasBorder; }
        public FFSection setHasBorder(Boolean value) { this.HasBorder = value; return this; }
        public String getBorderColor() { return BorderColor; }
        public FFSection setBorderColor(String value) { this.BorderColor = value; return this; }
        public Integer getBorderWidth() { return BorderWidth; }
        public FFSection setBorderWidth(Integer value) { this.BorderWidth = value; return this; }
        public Integer getBorderRadius() { return BorderRadius; }
        public FFSection setBorderRadius(Integer value) { this.BorderRadius = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public FFSection setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateModified() { return DateModified; }
        public FFSection setDateModified(Date value) { this.DateModified = value; return this; }
    }

    public static class FFFieldExtended extends FFField
    {
        public String Name = null;
        public Boolean IsYesNo = null;
        
        public String getName() { return Name; }
        public FFFieldExtended setName(String value) { this.Name = value; return this; }
        public Boolean getIsYesNo() { return IsYesNo; }
        public FFFieldExtended setIsYesNo(Boolean value) { this.IsYesNo = value; return this; }
    }

    public static class FFField
    {
        public UUID Id = null;
        public UUID FFSectionId = null;
        public Integer FieldTypeId = null;
        public Integer x = null;
        public Integer y = null;
        public Integer height = null;
        public Integer width = null;
        public String Text = null;
        
        public UUID getId() { return Id; }
        public FFField setId(UUID value) { this.Id = value; return this; }
        public UUID getFfSectionId() { return FFSectionId; }
        public FFField setFfSectionId(UUID value) { this.FFSectionId = value; return this; }
        public Integer getFieldTypeId() { return FieldTypeId; }
        public FFField setFieldTypeId(Integer value) { this.FieldTypeId = value; return this; }
        public Integer getX() { return x; }
        public FFField setX(Integer value) { this.x = value; return this; }
        public Integer getY() { return y; }
        public FFField setY(Integer value) { this.y = value; return this; }
        public Integer getHeight() { return height; }
        public FFField setHeight(Integer value) { this.height = value; return this; }
        public Integer getWidth() { return width; }
        public FFField setWidth(Integer value) { this.width = value; return this; }
        public String getText() { return Text; }
        public FFField setText(String value) { this.Text = value; return this; }
    }

    public static class FFAgentConfigResponse
    {
        public ResponseStatus ResponseStatus = null;
        public FFAgentConfigExtended FFAgentConfig = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FFAgentConfigResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public FFAgentConfigExtended getFfAgentConfig() { return FFAgentConfig; }
        public FFAgentConfigResponse setFfAgentConfig(FFAgentConfigExtended value) { this.FFAgentConfig = value; return this; }
    }

}

Java FFAgentConfigRequest 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/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>