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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
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-01,
		DateModified: 0001-01-01
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
		DateModified: 0001-01-01
	}
}