Trendsic Platform Service

<back to all web services

FFAgentConfigTemplateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/FFAgentConfigTemplate
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 FFAgentConfigTemplateRequest:
    ff_agent_config_id: Optional[str] = None
    template_id: Optional[str] = None

Python FFAgentConfigTemplateRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/FFAgentConfigTemplate HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FFAgentConfigId":"00000000000000000000000000000000","TemplateId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000"}],"Id":"00000000000000000000000000000000","AgentId":0,"DateCreated":"0001-01-01T00:00:00.0000000","DateModified":"0001-01-01T00:00:00.0000000"}}