Trendsic Platform Service

FFFieldTypeRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET	/v1/FFFieldType/{SectionTypeId}/{FFAgentConfigId}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class FFFieldType implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $SectionTypeId=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var int */
        public int $width=0,
        /** @var int */
        public int $height=0,
        /** @var bool|null */
        public ?bool $CanDuplicate=null,
        /** @var bool|null */
        public ?bool $IsYesNo=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['SectionTypeId'])) $this->SectionTypeId = $o['SectionTypeId'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['width'])) $this->width = $o['width'];
        if (isset($o['height'])) $this->height = $o['height'];
        if (isset($o['CanDuplicate'])) $this->CanDuplicate = $o['CanDuplicate'];
        if (isset($o['IsYesNo'])) $this->IsYesNo = $o['IsYesNo'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->SectionTypeId)) $o['SectionTypeId'] = $this->SectionTypeId;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->width)) $o['width'] = $this->width;
        if (isset($this->height)) $o['height'] = $this->height;
        if (isset($this->CanDuplicate)) $o['CanDuplicate'] = $this->CanDuplicate;
        if (isset($this->IsYesNo)) $o['IsYesNo'] = $this->IsYesNo;
        return empty($o) ? new class(){} : $o;
    }
}

class FFFieldTypeResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<FFFieldType>|null */
        public ?array $FFFieldType=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['FFFieldType'])) $this->FFFieldType = JsonConverters::fromArray('FFFieldType', $o['FFFieldType']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->FFFieldType)) $o['FFFieldType'] = JsonConverters::toArray('FFFieldType', $this->FFFieldType);
        return empty($o) ? new class(){} : $o;
    }
}

class FFFieldTypeRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $SectionTypeId=0,
        /** @var string */
        public string $FFAgentConfigId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SectionTypeId'])) $this->SectionTypeId = $o['SectionTypeId'];
        if (isset($o['FFAgentConfigId'])) $this->FFAgentConfigId = $o['FFAgentConfigId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SectionTypeId)) $o['SectionTypeId'] = $this->SectionTypeId;
        if (isset($this->FFAgentConfigId)) $o['FFAgentConfigId'] = $this->FFAgentConfigId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP FFFieldTypeRequest 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.

GET /v1/FFFieldType/{SectionTypeId}/{FFAgentConfigId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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
		}
	},
	FFFieldType: 
	[
		{
			Id: 0,
			SectionTypeId: 0,
			Name: String,
			width: 0,
			height: 0,
			CanDuplicate: False,
			IsYesNo: False
		}
	]
}