Platform API

<back to all web services

GetDefaultTemplates

Get default notification templates

Requires Authentication
The following routes are available for this service:
All Verbs/api/defaulttemplates
import 'package:servicestack/servicestack.dart';

class CommunicationTemplateBodyModel implements IConvertible
{
    String? Body;
    String? TemplateType;

    CommunicationTemplateBodyModel({this.Body,this.TemplateType});
    CommunicationTemplateBodyModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Body = json['Body'];
        TemplateType = json['TemplateType'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Body': Body,
        'TemplateType': TemplateType
    };

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

// @ApiResponse(Description="List of default notification templates")
class GetDefaultTemplatesResponse implements IConvertible
{
    List<CommunicationTemplateBodyModel>? Templates;
    ResponseStatus? ResponseStatus;

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

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

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

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

/**
* Get default notification templates
*/
// @Api(Description="Get default notification templates")
class GetDefaultTemplates implements IConvertible
{
    GetDefaultTemplates();
    GetDefaultTemplates.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "GetDefaultTemplates";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'CommunicationTemplateBodyModel': TypeInfo(TypeOf.Class, create:() => CommunicationTemplateBodyModel()),
    'GetDefaultTemplatesResponse': TypeInfo(TypeOf.Class, create:() => GetDefaultTemplatesResponse()),
    'List<CommunicationTemplateBodyModel>': TypeInfo(TypeOf.Class, create:() => <CommunicationTemplateBodyModel>[]),
    'GetDefaultTemplates': TypeInfo(TypeOf.Class, create:() => GetDefaultTemplates()),
});

Dart GetDefaultTemplates DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/defaulttemplates HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDefaultTemplates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDefaultTemplatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Templates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:CommunicationTemplateBodyModel>
      <d2p1:Body>String</d2p1:Body>
      <d2p1:TemplateType>00000000-0000-0000-0000-000000000000</d2p1:TemplateType>
    </d2p1:CommunicationTemplateBodyModel>
  </Templates>
</GetDefaultTemplatesResponse>