Platform API

GetCommunicationTemplates

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

The following routes are available for this service:
All Verbs	/api/communicationtemplates

import 'package:servicestack/servicestack.dart';

class CommunicationTemplateModel implements IConvertible
{
    /**
    * Communication Template Id
    */
    // @ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")
    String? CommunicationTemplateId;

    /**
    * Communication Template Name
    */
    // @ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")
    String? TemplateName;

    /**
    * Communication Template Subject
    */
    // @ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")
    String? Subject;

    /**
    * Communication Template Content
    */
    // @ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")
    String? Content;

    CommunicationTemplateModel({this.CommunicationTemplateId,this.TemplateName,this.Subject,this.Content});
    CommunicationTemplateModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CommunicationTemplateId = json['CommunicationTemplateId'];
        TemplateName = json['TemplateName'];
        Subject = json['Subject'];
        Content = json['Content'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CommunicationTemplateId': CommunicationTemplateId,
        'TemplateName': TemplateName,
        'Subject': Subject,
        'Content': Content
    };

    getTypeName() => "CommunicationTemplateModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="Details of the communication template.")
class GetCommunicationTemplateResponse implements IConvertible
{
    CommunicationTemplateModel? CommunicationTemplate;
    ResponseStatus? ResponseStatus;

    GetCommunicationTemplateResponse({this.CommunicationTemplate,this.ResponseStatus});
    GetCommunicationTemplateResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CommunicationTemplate = JsonConverters.fromJson(json['CommunicationTemplate'],'CommunicationTemplateModel',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CommunicationTemplate': JsonConverters.toJson(CommunicationTemplate,'CommunicationTemplateModel',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetCommunicationTemplateResponse";
    TypeContext? context = _ctx;
}

/**
* 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.")
class GetCommunicationTemplates implements IConvertible
{
    /**
    * 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")
    List<String>? SettingIds = [];

    GetCommunicationTemplates({this.SettingIds});
    GetCommunicationTemplates.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SettingIds = JsonConverters.fromJson(json['SettingIds'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SettingIds': JsonConverters.toJson(SettingIds,'List<String>',context!)
    };

    getTypeName() => "GetCommunicationTemplates";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'CommunicationTemplateModel': TypeInfo(TypeOf.Class, create:() => CommunicationTemplateModel()),
    'GetCommunicationTemplateResponse': TypeInfo(TypeOf.Class, create:() => GetCommunicationTemplateResponse()),
    'GetCommunicationTemplates': TypeInfo(TypeOf.Class, create:() => GetCommunicationTemplates()),
});

Dart GetCommunicationTemplates DTOs

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