| 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 .jsv suffix or ?format=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
}
}
}