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

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

Namespace Global

    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 Overridable Property CommunicationTemplateId As Guid

            '''<Summary>
            '''Communication Template Name
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Communication Template Name", IsRequired:=true, Name:="TemplateName")>
            Public Overridable Property TemplateName As String

            '''<Summary>
            '''Communication Template Subject
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Communication Template Subject", Name:="Subject")>
            Public Overridable Property Subject As String

            '''<Summary>
            '''Communication Template Content
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Communication Template Content", IsRequired:=true, Name:="Content")>
            Public Overridable Property Content As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        <ApiResponse(Description:="Details of the communication template.")>
        Public Partial Class GetCommunicationTemplateResponse
            Public Overridable Property CommunicationTemplate As CommunicationTemplateModel
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        '''<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 Overridable Property SettingIds As List(Of Guid) = New List(Of Guid)
        End Class
    End Namespace
End Namespace

VB.NET GetCommunicationTemplates 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/communicationtemplates HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

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