| All Verbs | /api/communicationtemplate/{SettingId} |
|---|
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 template for the current licensee and contact by setting id.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCommunicationTemplate:
"""
Get communication template for the current licensee and contact by setting id.
"""
# @ApiMember(Description="Setting Id linked to the communication template to get details for", IsRequired=true, Name="SettingId")
setting_id: Optional[str] = None
"""
Setting Id linked to the communication template to get details for
"""
Python GetCommunicationTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/communicationtemplate/{SettingId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"SettingId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}