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 .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>