| All Verbs | /api/communicationtemplates |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get communication templates for the current licensee and contact by setting ids.
*/
@Api(Description="Get communication templates for the current licensee and contact by setting ids.")
public static class GetCommunicationTemplates
{
/**
* Setting Id linked to the communication template to get details for
*/
@ApiMember(Description="Setting Id linked to the communication template to get details for", IsRequired=true, Name="SettingId")
public ArrayList<UUID> SettingIds = new ArrayList<UUID>();
public ArrayList<UUID> getSettingIds() { return SettingIds; }
public GetCommunicationTemplates setSettingIds(ArrayList<UUID> value) { this.SettingIds = value; return this; }
}
@ApiResponse(Description="Details of the communication template.")
public static class GetCommunicationTemplateResponse
{
public CommunicationTemplateModel CommunicationTemplate = null;
public ResponseStatus ResponseStatus = null;
public CommunicationTemplateModel getCommunicationTemplate() { return CommunicationTemplate; }
public GetCommunicationTemplateResponse setCommunicationTemplate(CommunicationTemplateModel value) { this.CommunicationTemplate = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetCommunicationTemplateResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class CommunicationTemplateModel
{
/**
* Communication Template Id
*/
@ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")
public UUID CommunicationTemplateId = null;
/**
* Communication Template Name
*/
@ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")
public String TemplateName = null;
/**
* Communication Template Subject
*/
@ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")
public String Subject = null;
/**
* Communication Template Content
*/
@ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")
public String Content = null;
public UUID getCommunicationTemplateId() { return CommunicationTemplateId; }
public CommunicationTemplateModel setCommunicationTemplateId(UUID value) { this.CommunicationTemplateId = value; return this; }
public String getTemplateName() { return TemplateName; }
public CommunicationTemplateModel setTemplateName(String value) { this.TemplateName = value; return this; }
public String getSubject() { return Subject; }
public CommunicationTemplateModel setSubject(String value) { this.Subject = value; return this; }
public String getContent() { return Content; }
public CommunicationTemplateModel setContent(String value) { this.Content = value; return this; }
}
}
Java GetCommunicationTemplates DTOs
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/communicationtemplates HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SettingIds:
[
00000000-0000-0000-0000-000000000000
]
}
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
}
}
}