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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFAgentConfig:
    id: Optional[str] = None
    agent_id: int = 0
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_modified: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFSection:
    id: Optional[str] = None
    ff_agent_config_id: Optional[str] = None
    section_type_id: int = 0
    nickname: Optional[str] = None
    show_header: bool = False
    header: Optional[str] = None
    height: int = 0
    width: int = 0
    x: int = 0
    y: int = 0
    is_active: bool = False
    has_border: bool = False
    border_color: Optional[str] = None
    border_width: int = 0
    border_radius: int = 0
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_modified: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFField:
    id: Optional[str] = None
    ff_section_id: Optional[str] = None
    field_type_id: int = 0
    x: int = 0
    y: int = 0
    height: int = 0
    width: int = 0
    text: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFFieldExtended(FFField):
    name: Optional[str] = None
    is_yes_no: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFSectionExtended(FFSection):
    section_type_desc: Optional[str] = None
    ff_fields: List[FFFieldExtended] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFAgentConfigExtended(FFAgentConfig):
    ff_sections: List[FFSectionExtended] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFAgentConfigResponse:
    response_status: Optional[ResponseStatus] = None
    ff_agent_config: Optional[FFAgentConfigExtended] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFAgentConfigRequest:
    ff_agent_config: Optional[FFAgentConfigExtended] = None

Python FFAgentConfigRequest 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/FFAgentConfig HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FFAgentConfig: 
	{
		FFSections: 
		[
			{
				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
			}
		],
		Id: 00000000000000000000000000000000,
		AgentId: 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
		}
	},
	FFAgentConfig: 
	{
		FFSections: 
		[
			{
				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
			}
		],
		Id: 00000000000000000000000000000000,
		AgentId: 0,
		DateCreated: 0001-01-01,
		DateModified: 0001-01-01
	}
}