BokaMera.API.Host

CreateNewsletterTemplate

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/newsletter/templates	Create a new company newsletter template.	Create a new company newsletter template.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class CreateNewsletterTemplate
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''The newsletter template heading.
            '''</Summary>
            <ApiMember(Description:="The newsletter template heading.")>
            Public Overridable Property Heading As String

            '''<Summary>
            '''The newsletter template body.
            '''</Summary>
            <ApiMember(Description:="The newsletter template body.")>
            Public Overridable Property Body As String

            '''<Summary>
            '''The newsletter template image url.
            '''</Summary>
            <ApiMember(Description:="The newsletter template image url.")>
            Public Overridable Property ImageUrl As String

            '''<Summary>
            '''The newsletter template send method (1=email, 2=sms).
            '''</Summary>
            <ApiMember(Description:="The newsletter template send method (1=email, 2=sms).")>
            Public Overridable Property SendMethodId As Integer

            '''<Summary>
            '''The email template id. Get valid email templates from GET /newsletter/emailtemplates
            '''</Summary>
            <ApiMember(Description:="The email template id. Get valid email templates from GET /newsletter/emailtemplates")>
            Public Overridable Property EmailTemplateId As Nullable(Of Integer)
        End Class

        Public Partial Class NewsletterEmailTemplatesQueryResponse
            '''<Summary>
            '''The email template id
            '''</Summary>
            <ApiMember(Description:="The email template id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The email template name.
            '''</Summary>
            <ApiMember(Description:="The email template name.")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The email template description.
            '''</Summary>
            <ApiMember(Description:="The email template description.")>
            Public Overridable Property Description As String

            '''<Summary>
            '''The email template html content.
            '''</Summary>
            <ApiMember(Description:="The email template html content.")>
            Public Overridable Property Body As String
        End Class

        Public Partial Class NewsletterSendMethodQueryResponse
            '''<Summary>
            '''The send method id
            '''</Summary>
            <ApiMember(Description:="The send method id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The send method name.
            '''</Summary>
            <ApiMember(Description:="The send method name.")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The send method description.
            '''</Summary>
            <ApiMember(Description:="The send method description.")>
            Public Overridable Property Description As String
        End Class

        Public Partial Class NewsletterTemplatesQueryResponse
            '''<Summary>
            '''The newsletter template id
            '''</Summary>
            <ApiMember(Description:="The newsletter template id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The newsletter template heading.
            '''</Summary>
            <ApiMember(Description:="The newsletter template heading.")>
            Public Overridable Property Heading As String

            '''<Summary>
            '''The newsletter template body.
            '''</Summary>
            <ApiMember(Description:="The newsletter template body.")>
            Public Overridable Property Body As String

            '''<Summary>
            '''The email template the newsletter uses.
            '''</Summary>
            <ApiMember(Description:="The email template the newsletter uses.")>
            Public Overridable Property EmailTemplateId As Nullable(Of Integer)

            '''<Summary>
            '''Send Method. 1 = Email, 2 = SMS
            '''</Summary>
            <ApiMember(Description:="Send Method. 1 = Email, 2 = SMS")>
            Public Overridable Property SendMethodId As Integer

            '''<Summary>
            '''The newsletter template image url.
            '''</Summary>
            <ApiMember(Description:="The newsletter template image url.")>
            Public Overridable Property ImageUrl As String

            '''<Summary>
            '''The newsletter created date.
            '''</Summary>
            <ApiMember(Description:="The newsletter created date.")>
            Public Overridable Property Created As Date

            '''<Summary>
            '''Send method information.
            '''</Summary>
            <ApiMember(Description:="Send method information.")>
            Public Overridable Property SendMethodInformation As NewsletterSendMethodQueryResponse

            '''<Summary>
            '''Email template information.
            '''</Summary>
            <ApiMember(Description:="Email template information.")>
            Public Overridable Property EmailTemplateInformation As NewsletterEmailTemplatesQueryResponse
        End Class
    End Namespace
End Namespace

VB.NET CreateNewsletterTemplate 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 /newsletter/templates HTTP/1.1 
Host: api.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>