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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class FFSectionRequest
    {
        public UUID Id = null;
        public FFSectionExtended FFSection = null;
        
        public UUID getId() { return Id; }
        public FFSectionRequest setId(UUID value) { this.Id = value; return this; }
        public FFSectionExtended getFfSection() { return FFSection; }
        public FFSectionRequest setFfSection(FFSectionExtended value) { this.FFSection = 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 FFSectionResponse
    {
        public ResponseStatus ResponseStatus = null;
        public FFSectionExtended FFSection = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FFSectionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public FFSectionExtended getFfSection() { return FFSection; }
        public FFSectionResponse setFfSection(FFSectionExtended value) { this.FFSection = value; return this; }
    }

}

Java FFSectionRequest DTOs

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
	}
}