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
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 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 FFSectionResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val FFSection:FFSectionExtended = null with get,set

    [<AllowNullLiteral>]
    type FFSectionRequest() = 
        member val Id:Guid = new Guid() with get,set
        member val FFSection:FFSectionExtended = null with get,set

F# FFSectionRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":"00000000000000000000000000000000","FFSection":{"SectionTypeDesc":"String","FFFields":[{"Name":"String","IsYesNo":false,"Id":"00000000000000000000000000000000","FFSectionId":"00000000000000000000000000000000","FieldTypeId":0,"x":0,"y":0,"height":0,"width":0,"Text":"String"}],"Id":"00000000000000000000000000000000","FFAgentConfigId":"00000000000000000000000000000000","SectionTypeId":0,"Nickname":"String","ShowHeader":false,"Header":"String","height":0,"width":0,"x":0,"y":0,"IsActive":false,"HasBorder":false,"BorderColor":"String","BorderWidth":0,"BorderRadius":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"FFSection":{"SectionTypeDesc":"String","FFFields":[{"Name":"String","IsYesNo":false,"Id":"00000000000000000000000000000000","FFSectionId":"00000000000000000000000000000000","FieldTypeId":0,"x":0,"y":0,"height":0,"width":0,"Text":"String"}],"Id":"00000000000000000000000000000000","FFAgentConfigId":"00000000000000000000000000000000","SectionTypeId":0,"Nickname":"String","ShowHeader":false,"Header":"String","height":0,"width":0,"x":0,"y":0,"IsActive":false,"HasBorder":false,"BorderColor":"String","BorderWidth":0,"BorderRadius":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000"}}