| All Verbs | /api/communicationtemplates |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get communication templates for the current licensee and contact by setting ids.
*/
@Api(Description="Get communication templates for the current licensee and contact by setting ids.")
open class GetCommunicationTemplates
{
/**
* 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")
open var SettingIds:ArrayList<UUID> = ArrayList<UUID>()
}
@ApiResponse(Description="Details of the communication template.")
open class GetCommunicationTemplateResponse
{
open var CommunicationTemplate:CommunicationTemplateModel? = null
open var ResponseStatus:ResponseStatus? = null
}
open class CommunicationTemplateModel
{
/**
* Communication Template Id
*/
@ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")
open var CommunicationTemplateId:UUID? = null
/**
* Communication Template Name
*/
@ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")
open var TemplateName:String? = null
/**
* Communication Template Subject
*/
@ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")
open var Subject:String? = null
/**
* Communication Template Content
*/
@ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")
open var Content:String? = null
}
Kotlin GetCommunicationTemplates 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/communicationtemplates HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SettingIds:
[
00000000-0000-0000-0000-000000000000
]
}
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
}
}
}