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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get default notification templates
*/
@Api(Description="Get default notification templates")
open class GetDefaultTemplates
{
}

@ApiResponse(Description="List of default notification templates")
open class GetDefaultTemplatesResponse
{
    open var Templates:ArrayList<CommunicationTemplateBodyModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CommunicationTemplateBodyModel
{
    open var Body:String? = null
    open var TemplateType:UUID? = null
}

Kotlin 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>