BokaMera.API.Host

SendNewsLetter

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

The following routes are available for this service:
POST	/newsletter/send	Send a newsletter to a customers.

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 SendNewsLetter
            Implements ICompany
            Public Sub New()
                Customers = New List(Of Guid)
            End Sub

            '''<Summary>
            '''The newsletter template id.
            '''</Summary>
            <ApiMember(Description:="The newsletter template id.", IsRequired:=true)>
            Public Overridable Property Id As Integer

            '''<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 datetime when the newsletters should be sent.
            '''</Summary>
            <ApiMember(Description:="The datetime when the newsletters should be sent.", IsRequired:=true)>
            Public Overridable Property SendDate As Date

            '''<Summary>
            '''The customer ids to send newsletters to.
            '''</Summary>
            <ApiMember(Description:="The customer ids to send newsletters to.", IsRequired:=true)>
            Public Overridable Property Customers As List(Of Guid)
        End Class

        Public Partial Class SendNewslettersResponse
            '''<Summary>
            '''The number of messages that are added into queue.
            '''</Summary>
            <ApiMember(Description:="The number of messages that are added into queue.")>
            Public Overridable Property Total As Integer

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

            '''<Summary>
            '''Message example sent (in HTML format)
            '''</Summary>
            <ApiMember(Description:="Message example sent (in HTML format)")>
            Public Overridable Property MessageExample As String
        End Class
    End Namespace
End Namespace

VB.NET SendNewsLetter 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/send HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendNewsLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Customers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Customers>
  <Id>0</Id>
  <SendDate>0001-01-01T00:00:00</SendDate>
</SendNewsLetter>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendNewslettersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <MessageExample>String</MessageExample>
  <SendMethodId>0</SendMethodId>
  <Total>0</Total>
</SendNewslettersResponse>