| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/templates | Create a new company newsletter template. | Create a new company newsletter template. |
|---|
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 NewsletterSendMethodQueryResponse:
# @ApiMember(Description="The send method id")
id: int = 0
"""
The send method id
"""
# @ApiMember(Description="The send method name.")
name: Optional[str] = None
"""
The send method name.
"""
# @ApiMember(Description="The send method description.")
description: Optional[str] = None
"""
The send method description.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterEmailTemplatesQueryResponse:
# @ApiMember(Description="The email template id")
id: int = 0
"""
The email template id
"""
# @ApiMember(Description="The email template name.")
name: Optional[str] = None
"""
The email template name.
"""
# @ApiMember(Description="The email template description.")
description: Optional[str] = None
"""
The email template description.
"""
# @ApiMember(Description="The email template html content.")
body: Optional[str] = None
"""
The email template html content.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterTemplatesQueryResponse:
# @ApiMember(Description="The newsletter template id")
id: int = 0
"""
The newsletter template id
"""
# @ApiMember(Description="The newsletter template heading.")
heading: Optional[str] = None
"""
The newsletter template heading.
"""
# @ApiMember(Description="The newsletter template body.")
body: Optional[str] = None
"""
The newsletter template body.
"""
# @ApiMember(Description="The email template the newsletter uses.")
email_template_id: Optional[int] = None
"""
The email template the newsletter uses.
"""
# @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
send_method_id: int = 0
"""
Send Method. 1 = Email, 2 = SMS
"""
# @ApiMember(Description="The newsletter template image url.")
image_url: Optional[str] = None
"""
The newsletter template image url.
"""
# @ApiMember(Description="The newsletter created date.")
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The newsletter created date.
"""
# @ApiMember(Description="Send method information.")
send_method_information: Optional[NewsletterSendMethodQueryResponse] = None
"""
Send method information.
"""
# @ApiMember(Description="Email template information.")
email_template_information: Optional[NewsletterEmailTemplatesQueryResponse] = None
"""
Email template information.
"""
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateNewsletterTemplate(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The newsletter template heading.")
heading: Optional[str] = None
"""
The newsletter template heading.
"""
# @ApiMember(Description="The newsletter template body.")
body: Optional[str] = None
"""
The newsletter template body.
"""
# @ApiMember(Description="The newsletter template image url.")
image_url: Optional[str] = None
"""
The newsletter template image url.
"""
# @ApiMember(Description="The newsletter template send method (1=email, 2=sms).")
send_method_id: int = 0
"""
The newsletter template send method (1=email, 2=sms).
"""
# @ApiMember(Description="The email template id. Get valid email templates from GET /newsletter/emailtemplates")
email_template_id: Optional[int] = None
"""
The email template id. Get valid email templates from GET /newsletter/emailtemplates
"""
Python CreateNewsletterTemplate 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 /newsletter/templates HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateNewsletterTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<EmailTemplateId>0</EmailTemplateId>
<Heading>String</Heading>
<ImageUrl>String</ImageUrl>
<SendMethodId>0</SendMethodId>
</CreateNewsletterTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NewsletterTemplatesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Body>String</Body>
<Created>0001-01-01T00:00:00</Created>
<EmailTemplateId>0</EmailTemplateId>
<EmailTemplateInformation>
<Body>String</Body>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</EmailTemplateInformation>
<Heading>String</Heading>
<Id>0</Id>
<ImageUrl>String</ImageUrl>
<SendMethodId>0</SendMethodId>
<SendMethodInformation>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</SendMethodInformation>
</NewsletterTemplatesQueryResponse>