Platform API

<back to all web services

GetCommunicationTemplates

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

Requires Authentication
The following routes are available for this service:
All Verbs/api/communicationtemplates
"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 GetCommunicationTemplates {
    /** @param {{SettingIds?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string[]}
     * @description Setting Id linked to the communication template to get details for */
    SettingIds = [];
}

JavaScript 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"}}}