Platform API

<back to all web services

GetCommunicationTemplate

Get communication template for the current licensee and contact by setting id.

Requires Authentication
The following routes are available for this service:
All Verbs/api/communicationtemplate/{SettingId}
"use strict";
export class CommunicationTemplateModel {
    /** @param {{CommunicationTemplateId?:string,TemplateName?:string,Subject?:string,Content?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Communication Template Id */
    CommunicationTemplateId;
    /**
     * @type {string}
     * @description Communication Template Name */
    TemplateName;
    /**
     * @type {string}
     * @description Communication Template Subject */
    Subject;
    /**
     * @type {string}
     * @description Communication Template Content */
    Content;
}
export class GetCommunicationTemplateResponse {
    /** @param {{CommunicationTemplate?:CommunicationTemplateModel,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CommunicationTemplateModel} */
    CommunicationTemplate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetCommunicationTemplate {
    /** @param {{SettingId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Setting Id linked to the communication template to get details for */
    SettingId;
}

JavaScript GetCommunicationTemplate DTOs

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

HTTP + JSV

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

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CommunicationTemplate: 
	{
		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
		}
	}
}