| 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 .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/communicationtemplates HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCommunicationTemplates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<SettingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SettingIds>
</GetCommunicationTemplates>
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>