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
<?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 FFField implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id='',
        /** @var string */
        public string $FFSectionId='',
        /** @var int */
        public int $FieldTypeId=0,
        /** @var int */
        public int $x=0,
        /** @var int */
        public int $y=0,
        /** @var int */
        public int $height=0,
        /** @var int */
        public int $width=0,
        /** @var string|null */
        public ?string $Text=null
    ) {
    }

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

class FFFieldExtended extends FFField implements JsonSerializable
{
    /**
     * @param string $Id
     * @param string $FFSectionId
     * @param int $FieldTypeId
     * @param int $x
     * @param int $y
     * @param int $height
     * @param int $width
     * @param string|null $Text
     */
    public function __construct(
        string $Id='',
        string $FFSectionId='',
        int $FieldTypeId=0,
        int $x=0,
        int $y=0,
        int $height=0,
        int $width=0,
        ?string $Text=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var bool|null */
        public ?bool $IsYesNo=null
    ) {
        parent::__construct($Id,$FFSectionId,$FieldTypeId,$x,$y,$height,$width,$Text);
    }

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

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

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

class FFFieldRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<FFFieldExtended>|null */
        public ?array $FFField=null
    ) {
    }

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

PHP FFFieldRequest 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/FFField/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
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: 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"}},"FFField":[{"Name":"String","IsYesNo":false,"Id":"00000000000000000000000000000000","FFSectionId":"00000000000000000000000000000000","FieldTypeId":0,"x":0,"y":0,"height":0,"width":0,"Text":"String"}]}