Trendsic Platform Service

<back to all web services

FFFieldRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/FFField/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/FFField
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 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 FFFieldResponse:
    response_status: Optional[ResponseStatus] = None
    ff_field: List[FFFieldExtended] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FFFieldRequest:
    ff_field: List[FFFieldExtended] = field(default_factory=list)

Python FFFieldRequest 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/FFField/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FFField: 
	[
		{
			Name: String,
			IsYesNo: False,
			Id: 00000000000000000000000000000000,
			FFSectionId: 00000000000000000000000000000000,
			FieldTypeId: 0,
			x: 0,
			y: 0,
			height: 0,
			width: 0,
			Text: String
		}
	]
}
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
		}
	},
	FFField: 
	[
		{
			Name: String,
			IsYesNo: False,
			Id: 00000000000000000000000000000000,
			FFSectionId: 00000000000000000000000000000000,
			FieldTypeId: 0,
			x: 0,
			y: 0,
			height: 0,
			width: 0,
			Text: String
		}
	]
}