Trendsic Platform Service

<back to all web services

FFSectionRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,DELETE,OPTIONS/v1/FFSection/{Id}
POST,PUT,OPTIONS/v1/FFSection
FFSectionRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidNo
FFSectionbodyFFSectionExtendedNo
FFSectionExtended Parameters:
NameParameterData TypeRequiredDescription
SectionTypeDescformstringNo
FFFieldsformList<FFFieldExtended>No
FFSection Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FFAgentConfigIdformGuidNo
SectionTypeIdformintNo
NicknameformstringNo
ShowHeaderformboolNo
HeaderformstringNo
heightformintNo
widthformintNo
xformintNo
yformintNo
IsActiveformboolNo
HasBorderformboolNo
BorderColorformstringNo
BorderWidthformintNo
BorderRadiusformintNo
DateCreatedformDateTimeNo
DateModifiedformDateTimeNo
FFFieldExtended Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IsYesNoformboolNo
FFField Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FFSectionIdformGuidNo
FieldTypeIdformintNo
xformintNo
yformintNo
heightformintNo
widthformintNo
TextformstringNo
FFSectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
FFSectionformFFSectionExtendedNo

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/FFSection HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FFSectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFSection>
    <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>
  </FFSection>
  <Id>00000000-0000-0000-0000-000000000000</Id>
</FFSectionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FFSectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFSection>
    <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>
  </FFSection>
  <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>
</FFSectionResponse>