| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/FFSection/{Id} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/FFSection |
<?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 FFSection implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $FFAgentConfigId='',
/** @var int */
public int $SectionTypeId=0,
/** @var string|null */
public ?string $Nickname=null,
/** @var bool|null */
public ?bool $ShowHeader=null,
/** @var string|null */
public ?string $Header=null,
/** @var int */
public int $height=0,
/** @var int */
public int $width=0,
/** @var int */
public int $x=0,
/** @var int */
public int $y=0,
/** @var bool|null */
public ?bool $IsActive=null,
/** @var bool|null */
public ?bool $HasBorder=null,
/** @var string|null */
public ?string $BorderColor=null,
/** @var int */
public int $BorderWidth=0,
/** @var int */
public int $BorderRadius=0,
/** @var DateTime */
public DateTime $DateCreated=new DateTime(),
/** @var DateTime */
public DateTime $DateModified=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['FFAgentConfigId'])) $this->FFAgentConfigId = $o['FFAgentConfigId'];
if (isset($o['SectionTypeId'])) $this->SectionTypeId = $o['SectionTypeId'];
if (isset($o['Nickname'])) $this->Nickname = $o['Nickname'];
if (isset($o['ShowHeader'])) $this->ShowHeader = $o['ShowHeader'];
if (isset($o['Header'])) $this->Header = $o['Header'];
if (isset($o['height'])) $this->height = $o['height'];
if (isset($o['width'])) $this->width = $o['width'];
if (isset($o['x'])) $this->x = $o['x'];
if (isset($o['y'])) $this->y = $o['y'];
if (isset($o['IsActive'])) $this->IsActive = $o['IsActive'];
if (isset($o['HasBorder'])) $this->HasBorder = $o['HasBorder'];
if (isset($o['BorderColor'])) $this->BorderColor = $o['BorderColor'];
if (isset($o['BorderWidth'])) $this->BorderWidth = $o['BorderWidth'];
if (isset($o['BorderRadius'])) $this->BorderRadius = $o['BorderRadius'];
if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
if (isset($o['DateModified'])) $this->DateModified = JsonConverters::from('DateTime', $o['DateModified']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->FFAgentConfigId)) $o['FFAgentConfigId'] = $this->FFAgentConfigId;
if (isset($this->SectionTypeId)) $o['SectionTypeId'] = $this->SectionTypeId;
if (isset($this->Nickname)) $o['Nickname'] = $this->Nickname;
if (isset($this->ShowHeader)) $o['ShowHeader'] = $this->ShowHeader;
if (isset($this->Header)) $o['Header'] = $this->Header;
if (isset($this->height)) $o['height'] = $this->height;
if (isset($this->width)) $o['width'] = $this->width;
if (isset($this->x)) $o['x'] = $this->x;
if (isset($this->y)) $o['y'] = $this->y;
if (isset($this->IsActive)) $o['IsActive'] = $this->IsActive;
if (isset($this->HasBorder)) $o['HasBorder'] = $this->HasBorder;
if (isset($this->BorderColor)) $o['BorderColor'] = $this->BorderColor;
if (isset($this->BorderWidth)) $o['BorderWidth'] = $this->BorderWidth;
if (isset($this->BorderRadius)) $o['BorderRadius'] = $this->BorderRadius;
if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
if (isset($this->DateModified)) $o['DateModified'] = JsonConverters::to('DateTime', $this->DateModified);
return empty($o) ? new class(){} : $o;
}
}
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 FFSectionExtended extends FFSection implements JsonSerializable
{
/**
* @param string $Id
* @param string $FFAgentConfigId
* @param int $SectionTypeId
* @param string|null $Nickname
* @param bool|null $ShowHeader
* @param string|null $Header
* @param int $height
* @param int $width
* @param int $x
* @param int $y
* @param bool|null $IsActive
* @param bool|null $HasBorder
* @param string|null $BorderColor
* @param int $BorderWidth
* @param int $BorderRadius
* @param DateTime $DateCreated
* @param DateTime $DateModified
*/
public function __construct(
string $Id='',
string $FFAgentConfigId='',
int $SectionTypeId=0,
?string $Nickname=null,
?bool $ShowHeader=null,
?string $Header=null,
int $height=0,
int $width=0,
int $x=0,
int $y=0,
?bool $IsActive=null,
?bool $HasBorder=null,
?string $BorderColor=null,
int $BorderWidth=0,
int $BorderRadius=0,
DateTime $DateCreated=new DateTime(),
DateTime $DateModified=new DateTime(),
/** @var string|null */
public ?string $SectionTypeDesc=null,
/** @var array<FFFieldExtended>|null */
public ?array $FFFields=null
) {
parent::__construct($Id,$FFAgentConfigId,$SectionTypeId,$Nickname,$ShowHeader,$Header,$height,$width,$x,$y,$IsActive,$HasBorder,$BorderColor,$BorderWidth,$BorderRadius,$DateCreated,$DateModified);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['SectionTypeDesc'])) $this->SectionTypeDesc = $o['SectionTypeDesc'];
if (isset($o['FFFields'])) $this->FFFields = JsonConverters::fromArray('FFFieldExtended', $o['FFFields']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->SectionTypeDesc)) $o['SectionTypeDesc'] = $this->SectionTypeDesc;
if (isset($this->FFFields)) $o['FFFields'] = JsonConverters::toArray('FFFieldExtended', $this->FFFields);
return empty($o) ? new class(){} : $o;
}
}
class FFSectionResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var FFSectionExtended|null */
public ?FFSectionExtended $FFSection=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['FFSection'])) $this->FFSection = JsonConverters::from('FFSectionExtended', $o['FFSection']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->FFSection)) $o['FFSection'] = JsonConverters::to('FFSectionExtended', $this->FFSection);
return empty($o) ? new class(){} : $o;
}
}
class FFSectionRequest implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var FFSectionExtended|null */
public ?FFSectionExtended $FFSection=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['FFSection'])) $this->FFSection = JsonConverters::from('FFSectionExtended', $o['FFSection']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->FFSection)) $o['FFSection'] = JsonConverters::to('FFSectionExtended', $this->FFSection);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/FFSection HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Id":"00000000000000000000000000000000","FFSection":{"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"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"FFSection":{"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"}}