| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| DELETE,OPTIONS | /v1/FFTemplate/{Id} | ||
|---|---|---|---|
| GET,POST,OPTIONS | /v1/FFTemplate |
<?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 FFTemplate implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string */
public string $FFAgentConfigId='',
/** @var string|null */
public ?string $Description=null
) {
}
/** @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['Description'])) $this->Description = $o['Description'];
}
/** @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->Description)) $o['Description'] = $this->Description;
return empty($o) ? new class(){} : $o;
}
}
class FFTemplateResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<FFTemplate>|null */
public ?array $FFTemplate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['FFTemplate'])) $this->FFTemplate = JsonConverters::fromArray('FFTemplate', $o['FFTemplate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->FFTemplate)) $o['FFTemplate'] = JsonConverters::toArray('FFTemplate', $this->FFTemplate);
return empty($o) ? new class(){} : $o;
}
}
class FFTemplateRequest implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var FFTemplate|null */
public ?FFTemplate $FFTemplate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['FFTemplate'])) $this->FFTemplate = JsonConverters::from('FFTemplate', $o['FFTemplate']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->FFTemplate)) $o['FFTemplate'] = JsonConverters::to('FFTemplate', $this->FFTemplate);
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/FFTemplate HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FFTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FFTemplate>
<Description>String</Description>
<FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</FFTemplate>
<Id>00000000-0000-0000-0000-000000000000</Id>
</FFTemplateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FFTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FFTemplate>
<FFTemplate>
<Description>String</Description>
<FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
<Id>00000000-0000-0000-0000-000000000000</Id>
</FFTemplate>
</FFTemplate>
<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>
</FFTemplateResponse>