| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,OPTIONS | /v1/FFAgentConfig |
|---|
<?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 FFAgentConfig implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var int */
public int $AgentId=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['AgentId'])) $this->AgentId = $o['AgentId'];
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->AgentId)) $o['AgentId'] = $this->AgentId;
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 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 FFAgentConfigExtended extends FFAgentConfig implements JsonSerializable
{
/**
* @param string $Id
* @param int $AgentId
* @param DateTime $DateCreated
* @param DateTime $DateModified
*/
public function __construct(
string $Id='',
int $AgentId=0,
DateTime $DateCreated=new DateTime(),
DateTime $DateModified=new DateTime(),
/** @var array<FFSectionExtended>|null */
public ?array $FFSections=null
) {
parent::__construct($Id,$AgentId,$DateCreated,$DateModified);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['FFSections'])) $this->FFSections = JsonConverters::fromArray('FFSectionExtended', $o['FFSections']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->FFSections)) $o['FFSections'] = JsonConverters::toArray('FFSectionExtended', $this->FFSections);
return empty($o) ? new class(){} : $o;
}
}
class FFAgentConfigResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var FFAgentConfigExtended|null */
public ?FFAgentConfigExtended $FFAgentConfig=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['FFAgentConfig'])) $this->FFAgentConfig = JsonConverters::from('FFAgentConfigExtended', $o['FFAgentConfig']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->FFAgentConfig)) $o['FFAgentConfig'] = JsonConverters::to('FFAgentConfigExtended', $this->FFAgentConfig);
return empty($o) ? new class(){} : $o;
}
}
class FFAgentConfigRequest implements JsonSerializable
{
public function __construct(
/** @var FFAgentConfigExtended|null */
public ?FFAgentConfigExtended $FFAgentConfig=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FFAgentConfig'])) $this->FFAgentConfig = JsonConverters::from('FFAgentConfigExtended', $o['FFAgentConfig']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FFAgentConfig)) $o['FFAgentConfig'] = JsonConverters::to('FFAgentConfigExtended', $this->FFAgentConfig);
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/FFAgentConfig HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FFAgentConfigRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FFAgentConfig>
<AgentId>0</AgentId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<Id>00000000-0000-0000-0000-000000000000</Id>
<FFSections>
<FFSectionExtended>
<BorderColor>String</BorderColor>
<BorderRadius>0</BorderRadius>
<BorderWidth>0</BorderWidth>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
<HasBorder>false</HasBorder>
<Header>String</Header>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsActive>false</IsActive>
<Nickname>String</Nickname>
<SectionTypeId>0</SectionTypeId>
<ShowHeader>false</ShowHeader>
<height>0</height>
<width>0</width>
<x>0</x>
<y>0</y>
<FFFields>
<FFFieldExtended>
<FFSectionId>00000000-0000-0000-0000-000000000000</FFSectionId>
<FieldTypeId>0</FieldTypeId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Text>String</Text>
<height>0</height>
<width>0</width>
<x>0</x>
<y>0</y>
<IsYesNo>false</IsYesNo>
<Name>String</Name>
</FFFieldExtended>
</FFFields>
<SectionTypeDesc>String</SectionTypeDesc>
</FFSectionExtended>
</FFSections>
</FFAgentConfig>
</FFAgentConfigRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FFAgentConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FFAgentConfig>
<AgentId>0</AgentId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<Id>00000000-0000-0000-0000-000000000000</Id>
<FFSections>
<FFSectionExtended>
<BorderColor>String</BorderColor>
<BorderRadius>0</BorderRadius>
<BorderWidth>0</BorderWidth>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
<HasBorder>false</HasBorder>
<Header>String</Header>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsActive>false</IsActive>
<Nickname>String</Nickname>
<SectionTypeId>0</SectionTypeId>
<ShowHeader>false</ShowHeader>
<height>0</height>
<width>0</width>
<x>0</x>
<y>0</y>
<FFFields>
<FFFieldExtended>
<FFSectionId>00000000-0000-0000-0000-000000000000</FFSectionId>
<FieldTypeId>0</FieldTypeId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Text>String</Text>
<height>0</height>
<width>0</width>
<x>0</x>
<y>0</y>
<IsYesNo>false</IsYesNo>
<Name>String</Name>
</FFFieldExtended>
</FFFields>
<SectionTypeDesc>String</SectionTypeDesc>
</FFSectionExtended>
</FFSections>
</FFAgentConfig>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</FFAgentConfigResponse>