Platform API

GetCommunicationTemplates

Get communication templates for the current licensee and contact by setting ids.

The following routes are available for this service:
All Verbs	/api/communicationtemplates

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class CommunicationTemplateModel
    {
        ///<summary>
        ///Communication Template Id
        ///</summary>
        [ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")]
        public virtual Guid CommunicationTemplateId { get; set; }

        ///<summary>
        ///Communication Template Name
        ///</summary>
        [ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")]
        public virtual string TemplateName { get; set; }

        ///<summary>
        ///Communication Template Subject
        ///</summary>
        [ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")]
        public virtual string Subject { get; set; }

        ///<summary>
        ///Communication Template Content
        ///</summary>
        [ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")]
        public virtual string Content { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    [ApiResponse(Description="Details of the communication template.")]
    public partial class GetCommunicationTemplateResponse
    {
        public virtual CommunicationTemplateModel CommunicationTemplate { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    ///<summary>
    ///Get communication templates for the current licensee and contact by setting ids.
    ///</summary>
    [Api(Description="Get communication templates for the current licensee and contact by setting ids.")]
    public partial class GetCommunicationTemplates
    {
        ///<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")]
        public virtual List<Guid> SettingIds { get; set; } = [];
    }

}

C# GetCommunicationTemplates 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/communicationtemplates HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"SettingIds":["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"}}}