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}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CommunicationTemplateModel() = 
        ///<summary>
        ///Communication Template Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")>]
        member val CommunicationTemplateId:Guid = new Guid() with get,set

        ///<summary>
        ///Communication Template Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")>]
        member val TemplateName:String = null with get,set

        ///<summary>
        ///Communication Template Subject
        ///</summary>
        [<ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")>]
        member val Subject:String = null with get,set

        ///<summary>
        ///Communication Template Content
        ///</summary>
        [<ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")>]
        member val Content:String = null with get,set

    [<ApiResponse(Description="Details of the communication template.")>]
    [<AllowNullLiteral>]
    type GetCommunicationTemplateResponse() = 
        member val CommunicationTemplate:CommunicationTemplateModel = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get communication template for the current licensee and contact by setting id.
    ///</summary>
    [<Api(Description="Get communication template for the current licensee and contact by setting id.")>]
    [<AllowNullLiteral>]
    type GetCommunicationTemplate() = 
        ///<summary>
        ///Setting Id linked to the communication template to get details for
        ///</summary>
        [<ApiMember(Description="Setting Id linked to the communication template to get details for", IsRequired=true, Name="SettingId")>]
        member val SettingId:Guid = new Guid() with get,set

F# GetCommunicationTemplate DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}