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}

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

        '''<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.")>
        Public Partial Class 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")>
            Public Overridable Property SettingId As Guid
        End Class

        <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
    End Namespace
End Namespace

VB.NET GetCommunicationTemplate DTOs

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

HTTP + XML

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

<GetCommunicationTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <SettingId>00000000-0000-0000-0000-000000000000</SettingId>
</GetCommunicationTemplate>

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>