| All Verbs | /api/communicationtemplate/{SettingId} |
|---|
export class CommunicationTemplateModel
{
/** @description Communication Template Id */
// @ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")
public CommunicationTemplateId: string;
/** @description Communication Template Name */
// @ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")
public TemplateName: string;
/** @description Communication Template Subject */
// @ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")
public Subject: string;
/** @description Communication Template Content */
// @ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")
public Content: string;
public constructor(init?: Partial<CommunicationTemplateModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Details of the communication template.")
export class GetCommunicationTemplateResponse
{
public CommunicationTemplate: CommunicationTemplateModel;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetCommunicationTemplateResponse>) { (Object as any).assign(this, init); }
}
/** @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.")
export class GetCommunicationTemplate
{
/** @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")
public SettingId: string;
public constructor(init?: Partial<GetCommunicationTemplate>) { (Object as any).assign(this, init); }
}
TypeScript GetCommunicationTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CommunicationTemplate:
{
TemplateName: String,
Subject: String,
Content: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}