| All Verbs | /api/communicationtemplate/{SettingId} |
|---|
<?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 CommunicationTemplateModel implements JsonSerializable
{
public function __construct(
/** @description Communication Template Id */
// @ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")
/** @var string */
public string $CommunicationTemplateId='',
/** @description Communication Template Name */
// @ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")
/** @var string */
public string $TemplateName='',
/** @description Communication Template Subject */
// @ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")
/** @var string|null */
public ?string $Subject=null,
/** @description Communication Template Content */
// @ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")
/** @var string */
public string $Content=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CommunicationTemplateId'])) $this->CommunicationTemplateId = $o['CommunicationTemplateId'];
if (isset($o['TemplateName'])) $this->TemplateName = $o['TemplateName'];
if (isset($o['Subject'])) $this->Subject = $o['Subject'];
if (isset($o['Content'])) $this->Content = $o['Content'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CommunicationTemplateId)) $o['CommunicationTemplateId'] = $this->CommunicationTemplateId;
if (isset($this->TemplateName)) $o['TemplateName'] = $this->TemplateName;
if (isset($this->Subject)) $o['Subject'] = $this->Subject;
if (isset($this->Content)) $o['Content'] = $this->Content;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="Details of the communication template.")
class GetCommunicationTemplateResponse implements JsonSerializable
{
public function __construct(
/** @var CommunicationTemplateModel|null */
public ?CommunicationTemplateModel $CommunicationTemplate=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CommunicationTemplate'])) $this->CommunicationTemplate = JsonConverters::from('CommunicationTemplateModel', $o['CommunicationTemplate']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CommunicationTemplate)) $o['CommunicationTemplate'] = JsonConverters::to('CommunicationTemplateModel', $this->CommunicationTemplate);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get communication template for the current licensee and contact by setting id. */
// @Api(Description="Get communication template for the current licensee and contact by setting id.")
class GetCommunicationTemplate implements JsonSerializable
{
public function __construct(
/** @description Setting Id linked to the communication template to get details for */
// @ApiMember(Description="Setting Id linked to the communication template to get details for", IsRequired=true, Name="SettingId")
/** @var string */
public string $SettingId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['SettingId'])) $this->SettingId = $o['SettingId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->SettingId)) $o['SettingId'] = $this->SettingId;
return empty($o) ? new class(){} : $o;
}
}
PHP GetCommunicationTemplate DTOs
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 /api/communicationtemplate/{SettingId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCommunicationTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<SettingId>00000000-0000-0000-0000-000000000000</SettingId>
</GetCommunicationTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCommunicationTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<CommunicationTemplate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:CommunicationTemplateId>00000000-0000-0000-0000-000000000000</d2p1:CommunicationTemplateId>
<d2p1:Content>String</d2p1:Content>
<d2p1:Subject>String</d2p1:Subject>
<d2p1:TemplateName>String</d2p1:TemplateName>
</CommunicationTemplate>
<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>
</GetCommunicationTemplateResponse>