| All Verbs | /api/communicationtemplate/{SettingId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingId | path | Guid | Yes | Setting Id linked to the communication template to get details for |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommunicationTemplate | form | CommunicationTemplateModel | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommunicationTemplateId | form | Guid | Yes | Communication Template Id |
| TemplateName | form | string | Yes | Communication Template Name |
| Subject | form | string | No | Communication Template Subject |
| Content | form | string | Yes | Communication Template Content |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"SettingId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}