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
GetCommunicationTemplates Parameters:
NameParameterData TypeRequiredDescription
SettingIdsqueryList<Guid>YesSetting Id linked to the communication template to get details for
GetCommunicationTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
CommunicationTemplateformCommunicationTemplateModelNo
ResponseStatusformResponseStatusNo
CommunicationTemplateModel Parameters:
NameParameterData TypeRequiredDescription
CommunicationTemplateIdformGuidYesCommunication Template Id
TemplateNameformstringYesCommunication Template Name
SubjectformstringNoCommunication Template Subject
ContentformstringYesCommunication Template Content

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

HTTP + OTHER

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

{"SettingIds":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}