Platform API

GetCommunicationTemplate

Get communication template for the current licensee and contact by setting id.

The following routes are available for this service:
All Verbs	/api/communicationtemplate/{SettingId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* 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.")
open class GetCommunicationTemplate
{
    /**
    * 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 SettingId:UUID? = null
}

@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 GetCommunicationTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"SettingId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CommunicationTemplate":{"CommunicationTemplateId":"00000000-0000-0000-0000-000000000000","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"}}}