| All Verbs | /api/communicationtemplates |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommunicationTemplateModel:
# @ApiMember(DataType="Guid", Description="Communication Template Id", IsRequired=true, Name="CommunicationTemplateId")
communication_template_id: Optional[str] = None
"""
Communication Template Id
"""
# @ApiMember(DataType="string", Description="Communication Template Name", IsRequired=true, Name="TemplateName")
template_name: Optional[str] = None
"""
Communication Template Name
"""
# @ApiMember(DataType="string", Description="Communication Template Subject", Name="Subject")
subject: Optional[str] = None
"""
Communication Template Subject
"""
# @ApiMember(DataType="string", Description="Communication Template Content", IsRequired=true, Name="Content")
content: Optional[str] = None
"""
Communication Template Content
"""
# @ApiResponse(Description="Details of the communication template.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCommunicationTemplateResponse:
communication_template: Optional[CommunicationTemplateModel] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get communication templates for the current licensee and contact by setting ids.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCommunicationTemplates:
"""
Get communication templates for the current licensee and contact by setting ids.
"""
# @ApiMember(Description="Setting Id linked to the communication template to get details for", IsRequired=true, Name="SettingId")
setting_ids: List[str] = field(default_factory=list)
"""
Setting Id linked to the communication template to get details for
"""
Python GetCommunicationTemplates DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetCommunicationTemplates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<SettingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SettingIds>
</GetCommunicationTemplates>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCommunicationTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<CommunicationTemplate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:CommunicationTemplateId>00000000-0000-0000-0000-000000000000</d2p1:CommunicationTemplateId>
<d2p1:Content>String</d2p1:Content>
<d2p1:Subject>String</d2p1:Subject>
<d2p1:TemplateName>String</d2p1:TemplateName>
</CommunicationTemplate>
<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>
</GetCommunicationTemplateResponse>